<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package ca.uhn.hl7v2.hoh.util.repackage;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.UnsupportedEncodingException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.math.BigInteger;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.nio.charset.Charset;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.nio.charset.UnsupportedCharsetException;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Provides Base64 encoding and decoding as defined by &lt;a<a name="line.26"></a>
<span class="sourceLineNo">027</span> * href="http://www.ietf.org/rfc/rfc2045.txt"&gt;RFC 2045&lt;/a&gt;.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * <a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * This class implements section &lt;cite&gt;6.8. Base64<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Content-Transfer-Encoding&lt;/cite&gt; from RFC 2045 &lt;cite&gt;Multipurpose Internet<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Mail Extensions (MIME) Part One: Format of Internet Message Bodies&lt;/cite&gt; by<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Freed and Borenstein.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * The class can be parameterized in the following manner with various<a name="line.36"></a>
<span class="sourceLineNo">037</span> * constructors:<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;ul&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;li&gt;URL-safe mode: Default off.&lt;/li&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;li&gt;Line length: Default 76. Line length that aren't multiples of 4 will<a name="line.40"></a>
<span class="sourceLineNo">041</span> * still essentially end up being multiples of 4 in the encoded data.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;li&gt;Line separator: Default is CRLF ("\r\n")&lt;/li&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;/ul&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;/p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Since this class operates directly on byte streams, and not character<a name="line.46"></a>
<span class="sourceLineNo">047</span> * streams, it is hard-coded to only encode/decode character encodings which are<a name="line.47"></a>
<span class="sourceLineNo">048</span> * compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8,<a name="line.48"></a>
<span class="sourceLineNo">049</span> * etc).<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;/p&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * This class is thread-safe.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;/p&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * <a name="line.54"></a>
<span class="sourceLineNo">055</span> * @see &lt;a href="http://www.ietf.org/rfc/rfc2045.txt"&gt;RFC 2045&lt;/a&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @author Note that this class has been repackaged from Apache Commons-Codec<a name="line.56"></a>
<span class="sourceLineNo">057</span> *         and is distributed under the terms of the Apache Software License,<a name="line.57"></a>
<span class="sourceLineNo">058</span> *         version 2.0<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span>public class Base64 {<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>        public static void main(String[] args) {<a name="line.62"></a>
<span class="sourceLineNo">063</span>                <a name="line.63"></a>
<span class="sourceLineNo">064</span>                System.out.println("basic " + encodeBase64String("cgta:d@3r$@TTg2446yhhh2h4".getBytes()));<a name="line.64"></a>
<span class="sourceLineNo">065</span>                <a name="line.65"></a>
<span class="sourceLineNo">066</span>        }<a name="line.66"></a>
<span class="sourceLineNo">067</span>        <a name="line.67"></a>
<span class="sourceLineNo">068</span>        /**<a name="line.68"></a>
<span class="sourceLineNo">069</span>         * BASE32 characters are 6 bits in length. They are formed by taking a block<a name="line.69"></a>
<span class="sourceLineNo">070</span>         * of 3 octets to form a 24-bit string, which is converted into 4 BASE64<a name="line.70"></a>
<span class="sourceLineNo">071</span>         * characters.<a name="line.71"></a>
<span class="sourceLineNo">072</span>         */<a name="line.72"></a>
<span class="sourceLineNo">073</span>        private static final int BITS_PER_ENCODED_BYTE = 6;<a name="line.73"></a>
<span class="sourceLineNo">074</span>        private static final int BYTES_PER_UNENCODED_BLOCK = 3;<a name="line.74"></a>
<span class="sourceLineNo">075</span>        private static final int BYTES_PER_ENCODED_BLOCK = 4;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>        /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>         * Chunk separator per RFC 2045 section 2.1.<a name="line.78"></a>
<span class="sourceLineNo">079</span>         * <a name="line.79"></a>
<span class="sourceLineNo">080</span>         * &lt;p&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span>         * N.B. The next major release may break compatibility and make this field<a name="line.81"></a>
<span class="sourceLineNo">082</span>         * private.<a name="line.82"></a>
<span class="sourceLineNo">083</span>         * &lt;/p&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span>         * <a name="line.84"></a>
<span class="sourceLineNo">085</span>         * @see &lt;a href="http://www.ietf.org/rfc/rfc2045.txt"&gt;RFC 2045 section<a name="line.85"></a>
<span class="sourceLineNo">086</span>         *      2.1&lt;/a&gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span>         */<a name="line.87"></a>
<span class="sourceLineNo">088</span>        static final byte[] CHUNK_SEPARATOR = { '\r', '\n' };<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>        /**<a name="line.90"></a>
<span class="sourceLineNo">091</span>         * This array is a lookup table that translates 6-bit positive integer index<a name="line.91"></a>
<span class="sourceLineNo">092</span>         * values into their "Base64 Alphabet" equivalents as specified in Table 1<a name="line.92"></a>
<span class="sourceLineNo">093</span>         * of RFC 2045.<a name="line.93"></a>
<span class="sourceLineNo">094</span>         * <a name="line.94"></a>
<span class="sourceLineNo">095</span>         * Thanks to "commons" project in ws.apache.org for this code.<a name="line.95"></a>
<span class="sourceLineNo">096</span>         * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/<a name="line.96"></a>
<span class="sourceLineNo">097</span>         */<a name="line.97"></a>
<span class="sourceLineNo">098</span>        private static final byte[] STANDARD_ENCODE_TABLE = { 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r',<a name="line.98"></a>
<span class="sourceLineNo">099</span>                        's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/' };<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>        /**<a name="line.101"></a>
<span class="sourceLineNo">102</span>         * This is a copy of the STANDARD_ENCODE_TABLE above, but with + and /<a name="line.102"></a>
<span class="sourceLineNo">103</span>         * changed to - and _ to make the encoded Base64 results more URL-SAFE. This<a name="line.103"></a>
<span class="sourceLineNo">104</span>         * table is only used when the Base64's mode is set to URL-SAFE.<a name="line.104"></a>
<span class="sourceLineNo">105</span>         */<a name="line.105"></a>
<span class="sourceLineNo">106</span>        private static final byte[] URL_SAFE_ENCODE_TABLE = { 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r',<a name="line.106"></a>
<span class="sourceLineNo">107</span>                        's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '_' };<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>        /**<a name="line.109"></a>
<span class="sourceLineNo">110</span>         * This array is a lookup table that translates Unicode characters drawn<a name="line.110"></a>
<span class="sourceLineNo">111</span>         * from the "Base64 Alphabet" (as specified in Table 1 of RFC 2045) into<a name="line.111"></a>
<span class="sourceLineNo">112</span>         * their 6-bit positive integer equivalents. Characters that are not in the<a name="line.112"></a>
<span class="sourceLineNo">113</span>         * Base64 alphabet but fall within the bounds of the array are translated to<a name="line.113"></a>
<span class="sourceLineNo">114</span>         * -1.<a name="line.114"></a>
<span class="sourceLineNo">115</span>         * <a name="line.115"></a>
<span class="sourceLineNo">116</span>         * Note: '+' and '-' both decode to 62. '/' and '_' both decode to 63. This<a name="line.116"></a>
<span class="sourceLineNo">117</span>         * means decoder seamlessly handles both URL_SAFE and STANDARD base64. (The<a name="line.117"></a>
<span class="sourceLineNo">118</span>         * encoder, on the other hand, needs to know ahead of time what to emit).<a name="line.118"></a>
<span class="sourceLineNo">119</span>         * <a name="line.119"></a>
<span class="sourceLineNo">120</span>         * Thanks to "commons" project in ws.apache.org for this code.<a name="line.120"></a>
<span class="sourceLineNo">121</span>         * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/<a name="line.121"></a>
<span class="sourceLineNo">122</span>         */<a name="line.122"></a>
<span class="sourceLineNo">123</span>        private static final byte[] DECODE_TABLE = { -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, 62, -1, 63, 52, 53, 54, 55, 56, 57, 58, 59, 60,<a name="line.123"></a>
<span class="sourceLineNo">124</span>                        61, -1, -1, -1, -1, -1, -1, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, 63, -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51 };<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span>        /**<a name="line.126"></a>
<span class="sourceLineNo">127</span>         * Base64 uses 6-bit fields.<a name="line.127"></a>
<span class="sourceLineNo">128</span>         */<a name="line.128"></a>
<span class="sourceLineNo">129</span>        /** Mask used to extract 6 bits, used when encoding */<a name="line.129"></a>
<span class="sourceLineNo">130</span>        private static final int MASK_6BITS = 0x3f;<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>        // The static final fields above are used for the original static byte[]<a name="line.132"></a>
<span class="sourceLineNo">133</span>        // methods on Base64.<a name="line.133"></a>
<span class="sourceLineNo">134</span>        // The private member fields below are used with the new streaming approach,<a name="line.134"></a>
<span class="sourceLineNo">135</span>        // which requires<a name="line.135"></a>
<span class="sourceLineNo">136</span>        // some state be preserved between calls of encode() and decode().<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span>        /**<a name="line.138"></a>
<span class="sourceLineNo">139</span>         * Encode table to use: either STANDARD or URL_SAFE. Note: the DECODE_TABLE<a name="line.139"></a>
<span class="sourceLineNo">140</span>         * above remains static because it is able to decode both STANDARD and<a name="line.140"></a>
<span class="sourceLineNo">141</span>         * URL_SAFE streams, but the encodeTable must be a member variable so we can<a name="line.141"></a>
<span class="sourceLineNo">142</span>         * switch between the two modes.<a name="line.142"></a>
<span class="sourceLineNo">143</span>         */<a name="line.143"></a>
<span class="sourceLineNo">144</span>        private byte[] encodeTable;<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span>        // Only one decode table currently; keep for consistency with Base32 code<a name="line.146"></a>
<span class="sourceLineNo">147</span>        private final byte[] decodeTable = DECODE_TABLE;<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span>        /**<a name="line.149"></a>
<span class="sourceLineNo">150</span>         * Line separator for encoding. Not used when decoding. Only used if<a name="line.150"></a>
<span class="sourceLineNo">151</span>         * lineLength &gt; 0.<a name="line.151"></a>
<span class="sourceLineNo">152</span>         */<a name="line.152"></a>
<span class="sourceLineNo">153</span>        private byte[] lineSeparator;<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span>        /**<a name="line.155"></a>
<span class="sourceLineNo">156</span>         * Convenience variable to help us determine when our buffer is going to run<a name="line.156"></a>
<span class="sourceLineNo">157</span>         * out of room and needs resizing.<a name="line.157"></a>
<span class="sourceLineNo">158</span>         * &lt;code&gt;decodeSize = 3 + lineSeparator.length;&lt;/code&gt;<a name="line.158"></a>
<span class="sourceLineNo">159</span>         */<a name="line.159"></a>
<span class="sourceLineNo">160</span>        private int decodeSize;<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span>        /**<a name="line.162"></a>
<span class="sourceLineNo">163</span>         * Convenience variable to help us determine when our buffer is going to run<a name="line.163"></a>
<span class="sourceLineNo">164</span>         * out of room and needs resizing.<a name="line.164"></a>
<span class="sourceLineNo">165</span>         * &lt;code&gt;encodeSize = 4 + lineSeparator.length;&lt;/code&gt;<a name="line.165"></a>
<span class="sourceLineNo">166</span>         */<a name="line.166"></a>
<span class="sourceLineNo">167</span>        private int encodeSize;<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span>        /**<a name="line.169"></a>
<span class="sourceLineNo">170</span>         * Creates a Base64 codec used for decoding (all modes) and encoding in<a name="line.170"></a>
<span class="sourceLineNo">171</span>         * URL-unsafe mode.<a name="line.171"></a>
<span class="sourceLineNo">172</span>         * &lt;p&gt;<a name="line.172"></a>
<span class="sourceLineNo">173</span>         * When encoding the line length is 0 (no chunking), and the encoding table<a name="line.173"></a>
<span class="sourceLineNo">174</span>         * is STANDARD_ENCODE_TABLE.<a name="line.174"></a>
<span class="sourceLineNo">175</span>         * &lt;/p&gt;<a name="line.175"></a>
<span class="sourceLineNo">176</span>         * <a name="line.176"></a>
<span class="sourceLineNo">177</span>         * &lt;p&gt;<a name="line.177"></a>
<span class="sourceLineNo">178</span>         * When decoding all variants are supported.<a name="line.178"></a>
<span class="sourceLineNo">179</span>         * &lt;/p&gt;<a name="line.179"></a>
<span class="sourceLineNo">180</span>         */<a name="line.180"></a>
<span class="sourceLineNo">181</span>        public Base64() {<a name="line.181"></a>
<span class="sourceLineNo">182</span>                this(0);<a name="line.182"></a>
<span class="sourceLineNo">183</span>        }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>        /**<a name="line.185"></a>
<span class="sourceLineNo">186</span>         * Creates a Base64 codec used for decoding (all modes) and encoding in the<a name="line.186"></a>
<span class="sourceLineNo">187</span>         * given URL-safe mode.<a name="line.187"></a>
<span class="sourceLineNo">188</span>         * &lt;p&gt;<a name="line.188"></a>
<span class="sourceLineNo">189</span>         * When encoding the line length is 76, the line separator is CRLF, and the<a name="line.189"></a>
<span class="sourceLineNo">190</span>         * encoding table is STANDARD_ENCODE_TABLE.<a name="line.190"></a>
<span class="sourceLineNo">191</span>         * &lt;/p&gt;<a name="line.191"></a>
<span class="sourceLineNo">192</span>         * <a name="line.192"></a>
<span class="sourceLineNo">193</span>         * &lt;p&gt;<a name="line.193"></a>
<span class="sourceLineNo">194</span>         * When decoding all variants are supported.<a name="line.194"></a>
<span class="sourceLineNo">195</span>         * &lt;/p&gt;<a name="line.195"></a>
<span class="sourceLineNo">196</span>         * <a name="line.196"></a>
<span class="sourceLineNo">197</span>         * @param urlSafe<a name="line.197"></a>
<span class="sourceLineNo">198</span>         *            if {@code true}, URL-safe encoding is used. In most cases this<a name="line.198"></a>
<span class="sourceLineNo">199</span>         *            should be set to {@code false}.<a name="line.199"></a>
<span class="sourceLineNo">200</span>         * @since 1.4<a name="line.200"></a>
<span class="sourceLineNo">201</span>         */<a name="line.201"></a>
<span class="sourceLineNo">202</span>        public Base64(boolean urlSafe) {<a name="line.202"></a>
<span class="sourceLineNo">203</span>                this(MIME_CHUNK_SIZE, CHUNK_SEPARATOR, urlSafe);<a name="line.203"></a>
<span class="sourceLineNo">204</span>        }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span>        /**<a name="line.206"></a>
<span class="sourceLineNo">207</span>         * Creates a Base64 codec used for decoding (all modes) and encoding in<a name="line.207"></a>
<span class="sourceLineNo">208</span>         * URL-unsafe mode.<a name="line.208"></a>
<span class="sourceLineNo">209</span>         * &lt;p&gt;<a name="line.209"></a>
<span class="sourceLineNo">210</span>         * When encoding the line length is given in the constructor, the line<a name="line.210"></a>
<span class="sourceLineNo">211</span>         * separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.<a name="line.211"></a>
<span class="sourceLineNo">212</span>         * &lt;/p&gt;<a name="line.212"></a>
<span class="sourceLineNo">213</span>         * &lt;p&gt;<a name="line.213"></a>
<span class="sourceLineNo">214</span>         * Line lengths that aren't multiples of 4 will still essentially end up<a name="line.214"></a>
<span class="sourceLineNo">215</span>         * being multiples of 4 in the encoded data.<a name="line.215"></a>
<span class="sourceLineNo">216</span>         * &lt;/p&gt;<a name="line.216"></a>
<span class="sourceLineNo">217</span>         * &lt;p&gt;<a name="line.217"></a>
<span class="sourceLineNo">218</span>         * When decoding all variants are supported.<a name="line.218"></a>
<span class="sourceLineNo">219</span>         * &lt;/p&gt;<a name="line.219"></a>
<span class="sourceLineNo">220</span>         * <a name="line.220"></a>
<span class="sourceLineNo">221</span>         * @param lineLength<a name="line.221"></a>
<span class="sourceLineNo">222</span>         *            Each line of encoded data will be at most of the given length<a name="line.222"></a>
<span class="sourceLineNo">223</span>         *            (rounded down to nearest multiple of 4). If lineLength &lt;= 0,<a name="line.223"></a>
<span class="sourceLineNo">224</span>         *            then the output will not be divided into lines (chunks).<a name="line.224"></a>
<span class="sourceLineNo">225</span>         *            Ignored when decoding.<a name="line.225"></a>
<span class="sourceLineNo">226</span>         * @since 1.4<a name="line.226"></a>
<span class="sourceLineNo">227</span>         */<a name="line.227"></a>
<span class="sourceLineNo">228</span>        public Base64(int lineLength) {<a name="line.228"></a>
<span class="sourceLineNo">229</span>                this(lineLength, CHUNK_SEPARATOR);<a name="line.229"></a>
<span class="sourceLineNo">230</span>        }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span>        /**<a name="line.232"></a>
<span class="sourceLineNo">233</span>         * Creates a Base64 codec used for decoding (all modes) and encoding in<a name="line.233"></a>
<span class="sourceLineNo">234</span>         * URL-unsafe mode.<a name="line.234"></a>
<span class="sourceLineNo">235</span>         * &lt;p&gt;<a name="line.235"></a>
<span class="sourceLineNo">236</span>         * When encoding the line length and line separator are given in the<a name="line.236"></a>
<span class="sourceLineNo">237</span>         * constructor, and the encoding table is STANDARD_ENCODE_TABLE.<a name="line.237"></a>
<span class="sourceLineNo">238</span>         * &lt;/p&gt;<a name="line.238"></a>
<span class="sourceLineNo">239</span>         * &lt;p&gt;<a name="line.239"></a>
<span class="sourceLineNo">240</span>         * Line lengths that aren't multiples of 4 will still essentially end up<a name="line.240"></a>
<span class="sourceLineNo">241</span>         * being multiples of 4 in the encoded data.<a name="line.241"></a>
<span class="sourceLineNo">242</span>         * &lt;/p&gt;<a name="line.242"></a>
<span class="sourceLineNo">243</span>         * &lt;p&gt;<a name="line.243"></a>
<span class="sourceLineNo">244</span>         * When decoding all variants are supported.<a name="line.244"></a>
<span class="sourceLineNo">245</span>         * &lt;/p&gt;<a name="line.245"></a>
<span class="sourceLineNo">246</span>         * <a name="line.246"></a>
<span class="sourceLineNo">247</span>         * @param lineLength<a name="line.247"></a>
<span class="sourceLineNo">248</span>         *            Each line of encoded data will be at most of the given length<a name="line.248"></a>
<span class="sourceLineNo">249</span>         *            (rounded down to nearest multiple of 4). If lineLength &lt;= 0,<a name="line.249"></a>
<span class="sourceLineNo">250</span>         *            then the output will not be divided into lines (chunks).<a name="line.250"></a>
<span class="sourceLineNo">251</span>         *            Ignored when decoding.<a name="line.251"></a>
<span class="sourceLineNo">252</span>         * @param lineSeparator<a name="line.252"></a>
<span class="sourceLineNo">253</span>         *            Each line of encoded data will end with this sequence of<a name="line.253"></a>
<span class="sourceLineNo">254</span>         *            bytes.<a name="line.254"></a>
<span class="sourceLineNo">255</span>         * @throws IllegalArgumentException<a name="line.255"></a>
<span class="sourceLineNo">256</span>         *             Thrown when the provided lineSeparator included some base64<a name="line.256"></a>
<span class="sourceLineNo">257</span>         *             characters.<a name="line.257"></a>
<span class="sourceLineNo">258</span>         * @since 1.4<a name="line.258"></a>
<span class="sourceLineNo">259</span>         */<a name="line.259"></a>
<span class="sourceLineNo">260</span>        public Base64(int lineLength, byte[] lineSeparator) {<a name="line.260"></a>
<span class="sourceLineNo">261</span>                this(lineLength, lineSeparator, false);<a name="line.261"></a>
<span class="sourceLineNo">262</span>        }<a name="line.262"></a>
<span class="sourceLineNo">263</span><a name="line.263"></a>
<span class="sourceLineNo">264</span>        /**<a name="line.264"></a>
<span class="sourceLineNo">265</span>         * Creates a Base64 codec used for decoding (all modes) and encoding in<a name="line.265"></a>
<span class="sourceLineNo">266</span>         * URL-unsafe mode.<a name="line.266"></a>
<span class="sourceLineNo">267</span>         * &lt;p&gt;<a name="line.267"></a>
<span class="sourceLineNo">268</span>         * When encoding the line length and line separator are given in the<a name="line.268"></a>
<span class="sourceLineNo">269</span>         * constructor, and the encoding table is STANDARD_ENCODE_TABLE.<a name="line.269"></a>
<span class="sourceLineNo">270</span>         * &lt;/p&gt;<a name="line.270"></a>
<span class="sourceLineNo">271</span>         * &lt;p&gt;<a name="line.271"></a>
<span class="sourceLineNo">272</span>         * Line lengths that aren't multiples of 4 will still essentially end up<a name="line.272"></a>
<span class="sourceLineNo">273</span>         * being multiples of 4 in the encoded data.<a name="line.273"></a>
<span class="sourceLineNo">274</span>         * &lt;/p&gt;<a name="line.274"></a>
<span class="sourceLineNo">275</span>         * &lt;p&gt;<a name="line.275"></a>
<span class="sourceLineNo">276</span>         * When decoding all variants are supported.<a name="line.276"></a>
<span class="sourceLineNo">277</span>         * &lt;/p&gt;<a name="line.277"></a>
<span class="sourceLineNo">278</span>         * <a name="line.278"></a>
<span class="sourceLineNo">279</span>         * @param lineLength<a name="line.279"></a>
<span class="sourceLineNo">280</span>         *            Each line of encoded data will be at most of the given length<a name="line.280"></a>
<span class="sourceLineNo">281</span>         *            (rounded down to nearest multiple of 4). If lineLength &lt;= 0,<a name="line.281"></a>
<span class="sourceLineNo">282</span>         *            then the output will not be divided into lines (chunks).<a name="line.282"></a>
<span class="sourceLineNo">283</span>         *            Ignored when decoding.<a name="line.283"></a>
<span class="sourceLineNo">284</span>         * @param lineSeparator<a name="line.284"></a>
<span class="sourceLineNo">285</span>         *            Each line of encoded data will end with this sequence of<a name="line.285"></a>
<span class="sourceLineNo">286</span>         *            bytes.<a name="line.286"></a>
<span class="sourceLineNo">287</span>         * @param urlSafe<a name="line.287"></a>
<span class="sourceLineNo">288</span>         *            Instead of emitting '+' and '/' we emit '-' and '_'<a name="line.288"></a>
<span class="sourceLineNo">289</span>         *            respectively. urlSafe is only applied to encode operations.<a name="line.289"></a>
<span class="sourceLineNo">290</span>         *            Decoding seamlessly handles both modes.<a name="line.290"></a>
<span class="sourceLineNo">291</span>         * @throws IllegalArgumentException<a name="line.291"></a>
<span class="sourceLineNo">292</span>         *             The provided lineSeparator included some base64 characters.<a name="line.292"></a>
<span class="sourceLineNo">293</span>         *             That's not going to work!<a name="line.293"></a>
<span class="sourceLineNo">294</span>         * @since 1.4<a name="line.294"></a>
<span class="sourceLineNo">295</span>         */<a name="line.295"></a>
<span class="sourceLineNo">296</span>        public Base64(int lineLength, byte[] lineSeparator, boolean urlSafe) {<a name="line.296"></a>
<span class="sourceLineNo">297</span>                this(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, lineSeparator == null ? 0 : lineSeparator.length);<a name="line.297"></a>
<span class="sourceLineNo">298</span>                // TODO could be simplified if there is no requirement to reject invalid<a name="line.298"></a>
<span class="sourceLineNo">299</span>                // line sep when length &lt;=0<a name="line.299"></a>
<span class="sourceLineNo">300</span>                // @see test case Base64Test.testConstructors()<a name="line.300"></a>
<span class="sourceLineNo">301</span>                if (lineSeparator != null) {<a name="line.301"></a>
<span class="sourceLineNo">302</span>                        if (containsAlphabetOrPad(lineSeparator)) {<a name="line.302"></a>
<span class="sourceLineNo">303</span>                                String sep = StringUtils.newStringUtf8(lineSeparator);<a name="line.303"></a>
<span class="sourceLineNo">304</span>                                throw new IllegalArgumentException("lineSeparator must not contain base64 characters: [" + sep + "]");<a name="line.304"></a>
<span class="sourceLineNo">305</span>                        }<a name="line.305"></a>
<span class="sourceLineNo">306</span>                        if (lineLength &gt; 0) { // null line-sep forces no chunking rather<a name="line.306"></a>
<span class="sourceLineNo">307</span>                                                                        // than throwing IAE<a name="line.307"></a>
<span class="sourceLineNo">308</span>                                this.encodeSize = BYTES_PER_ENCODED_BLOCK + lineSeparator.length;<a name="line.308"></a>
<span class="sourceLineNo">309</span>                                this.lineSeparator = new byte[lineSeparator.length];<a name="line.309"></a>
<span class="sourceLineNo">310</span>                                System.arraycopy(lineSeparator, 0, this.lineSeparator, 0, lineSeparator.length);<a name="line.310"></a>
<span class="sourceLineNo">311</span>                        } else {<a name="line.311"></a>
<span class="sourceLineNo">312</span>                                this.encodeSize = BYTES_PER_ENCODED_BLOCK;<a name="line.312"></a>
<span class="sourceLineNo">313</span>                                this.lineSeparator = null;<a name="line.313"></a>
<span class="sourceLineNo">314</span>                        }<a name="line.314"></a>
<span class="sourceLineNo">315</span>                } else {<a name="line.315"></a>
<span class="sourceLineNo">316</span>                        this.encodeSize = BYTES_PER_ENCODED_BLOCK;<a name="line.316"></a>
<span class="sourceLineNo">317</span>                        this.lineSeparator = null;<a name="line.317"></a>
<span class="sourceLineNo">318</span>                }<a name="line.318"></a>
<span class="sourceLineNo">319</span>                this.decodeSize = this.encodeSize - 1;<a name="line.319"></a>
<span class="sourceLineNo">320</span>                this.encodeTable = urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE;<a name="line.320"></a>
<span class="sourceLineNo">321</span>        }<a name="line.321"></a>
<span class="sourceLineNo">322</span><a name="line.322"></a>
<span class="sourceLineNo">323</span>        /**<a name="line.323"></a>
<span class="sourceLineNo">324</span>         * Returns our current encode mode. True if we're URL-SAFE, false otherwise.<a name="line.324"></a>
<span class="sourceLineNo">325</span>         * <a name="line.325"></a>
<span class="sourceLineNo">326</span>         * @return true if we're in URL-SAFE mode, false otherwise.<a name="line.326"></a>
<span class="sourceLineNo">327</span>         * @since 1.4<a name="line.327"></a>
<span class="sourceLineNo">328</span>         */<a name="line.328"></a>
<span class="sourceLineNo">329</span>        public boolean isUrlSafe() {<a name="line.329"></a>
<span class="sourceLineNo">330</span>                return this.encodeTable == URL_SAFE_ENCODE_TABLE;<a name="line.330"></a>
<span class="sourceLineNo">331</span>        }<a name="line.331"></a>
<span class="sourceLineNo">332</span><a name="line.332"></a>
<span class="sourceLineNo">333</span>        /**<a name="line.333"></a>
<span class="sourceLineNo">334</span>         * &lt;p&gt;<a name="line.334"></a>
<span class="sourceLineNo">335</span>         * Encodes all of the provided data, starting at inPos, for inAvail bytes.<a name="line.335"></a>
<span class="sourceLineNo">336</span>         * Must be called at least twice: once with the data to encode, and once<a name="line.336"></a>
<span class="sourceLineNo">337</span>         * with inAvail set to "-1" to alert encoder that EOF has been reached, so<a name="line.337"></a>
<span class="sourceLineNo">338</span>         * flush last remaining bytes (if not multiple of 3).<a name="line.338"></a>
<span class="sourceLineNo">339</span>         * &lt;/p&gt;<a name="line.339"></a>
<span class="sourceLineNo">340</span>         * &lt;p&gt;<a name="line.340"></a>
<span class="sourceLineNo">341</span>         * Thanks to "commons" project in ws.apache.org for the bitwise operations,<a name="line.341"></a>
<span class="sourceLineNo">342</span>         * and general approach.<a name="line.342"></a>
<span class="sourceLineNo">343</span>         * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/<a name="line.343"></a>
<span class="sourceLineNo">344</span>         * &lt;/p&gt;<a name="line.344"></a>
<span class="sourceLineNo">345</span>         * <a name="line.345"></a>
<span class="sourceLineNo">346</span>         * @param in<a name="line.346"></a>
<span class="sourceLineNo">347</span>         *            byte[] array of binary data to base64 encode.<a name="line.347"></a>
<span class="sourceLineNo">348</span>         * @param inPos<a name="line.348"></a>
<span class="sourceLineNo">349</span>         *            Position to start reading data from.<a name="line.349"></a>
<span class="sourceLineNo">350</span>         * @param inAvail<a name="line.350"></a>
<span class="sourceLineNo">351</span>         *            Amount of bytes available from input for encoding.<a name="line.351"></a>
<span class="sourceLineNo">352</span>         * @param context<a name="line.352"></a>
<span class="sourceLineNo">353</span>         *            the context to be used<a name="line.353"></a>
<span class="sourceLineNo">354</span>         */<a name="line.354"></a>
<span class="sourceLineNo">355</span>        void encode(byte[] in, int inPos, int inAvail, Context context) {<a name="line.355"></a>
<span class="sourceLineNo">356</span>                if (context.eof) {<a name="line.356"></a>
<span class="sourceLineNo">357</span>                        return;<a name="line.357"></a>
<span class="sourceLineNo">358</span>                }<a name="line.358"></a>
<span class="sourceLineNo">359</span>                // inAvail &lt; 0 is how we're informed of EOF in the underlying data we're<a name="line.359"></a>
<span class="sourceLineNo">360</span>                // encoding.<a name="line.360"></a>
<span class="sourceLineNo">361</span>                if (inAvail &lt; 0) {<a name="line.361"></a>
<span class="sourceLineNo">362</span>                        context.eof = true;<a name="line.362"></a>
<span class="sourceLineNo">363</span>                        if (0 == context.modulus &amp;&amp; lineLength == 0) {<a name="line.363"></a>
<span class="sourceLineNo">364</span>                                return; // no leftovers to process and not using chunking<a name="line.364"></a>
<span class="sourceLineNo">365</span>                        }<a name="line.365"></a>
<span class="sourceLineNo">366</span>                        ensureBufferSize(encodeSize, context);<a name="line.366"></a>
<span class="sourceLineNo">367</span>                        int savedPos = context.pos;<a name="line.367"></a>
<span class="sourceLineNo">368</span>                        switch (context.modulus) { // 0-2<a name="line.368"></a>
<span class="sourceLineNo">369</span>                        case 1: // 8 bits = 6 + 2<a name="line.369"></a>
<span class="sourceLineNo">370</span>                                context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &gt;&gt; 2) &amp; MASK_6BITS]; // top<a name="line.370"></a>
<span class="sourceLineNo">371</span>                                                                                                                                                                                                                // 6<a name="line.371"></a>
<span class="sourceLineNo">372</span>                                                                                                                                                                                                                // bits<a name="line.372"></a>
<span class="sourceLineNo">373</span>                                context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &lt;&lt; 4) &amp; MASK_6BITS]; // remaining<a name="line.373"></a>
<span class="sourceLineNo">374</span>                                                                                                                                                                                                                // 2<a name="line.374"></a>
<span class="sourceLineNo">375</span>                                // URL-SAFE skips the padding to further reduce size.<a name="line.375"></a>
<span class="sourceLineNo">376</span>                                if (encodeTable == STANDARD_ENCODE_TABLE) {<a name="line.376"></a>
<span class="sourceLineNo">377</span>                                        context.buffer[context.pos++] = PAD;<a name="line.377"></a>
<span class="sourceLineNo">378</span>                                        context.buffer[context.pos++] = PAD;<a name="line.378"></a>
<span class="sourceLineNo">379</span>                                }<a name="line.379"></a>
<span class="sourceLineNo">380</span>                                break;<a name="line.380"></a>
<span class="sourceLineNo">381</span><a name="line.381"></a>
<span class="sourceLineNo">382</span>                        case 2: // 16 bits = 6 + 6 + 4<a name="line.382"></a>
<span class="sourceLineNo">383</span>                                context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &gt;&gt; 10) &amp; MASK_6BITS];<a name="line.383"></a>
<span class="sourceLineNo">384</span>                                context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &gt;&gt; 4) &amp; MASK_6BITS];<a name="line.384"></a>
<span class="sourceLineNo">385</span>                                context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &lt;&lt; 2) &amp; MASK_6BITS];<a name="line.385"></a>
<span class="sourceLineNo">386</span>                                // URL-SAFE skips the padding to further reduce size.<a name="line.386"></a>
<span class="sourceLineNo">387</span>                                if (encodeTable == STANDARD_ENCODE_TABLE) {<a name="line.387"></a>
<span class="sourceLineNo">388</span>                                        context.buffer[context.pos++] = PAD;<a name="line.388"></a>
<span class="sourceLineNo">389</span>                                }<a name="line.389"></a>
<span class="sourceLineNo">390</span>                                break;<a name="line.390"></a>
<span class="sourceLineNo">391</span>                        }<a name="line.391"></a>
<span class="sourceLineNo">392</span>                        context.currentLinePos += context.pos - savedPos; // keep track of<a name="line.392"></a>
<span class="sourceLineNo">393</span>                                                                                                                                // current line<a name="line.393"></a>
<span class="sourceLineNo">394</span>                                                                                                                                // position<a name="line.394"></a>
<span class="sourceLineNo">395</span>                        // if currentPos == 0 we are at the start of a line, so don't add<a name="line.395"></a>
<span class="sourceLineNo">396</span>                        // CRLF<a name="line.396"></a>
<span class="sourceLineNo">397</span>                        if (lineLength &gt; 0 &amp;&amp; context.currentLinePos &gt; 0) {<a name="line.397"></a>
<span class="sourceLineNo">398</span>                                System.arraycopy(lineSeparator, 0, context.buffer, context.pos, lineSeparator.length);<a name="line.398"></a>
<span class="sourceLineNo">399</span>                                context.pos += lineSeparator.length;<a name="line.399"></a>
<span class="sourceLineNo">400</span>                        }<a name="line.400"></a>
<span class="sourceLineNo">401</span>                } else {<a name="line.401"></a>
<span class="sourceLineNo">402</span>                        for (int i = 0; i &lt; inAvail; i++) {<a name="line.402"></a>
<span class="sourceLineNo">403</span>                                ensureBufferSize(encodeSize, context);<a name="line.403"></a>
<span class="sourceLineNo">404</span>                                context.modulus = (context.modulus + 1) % BYTES_PER_UNENCODED_BLOCK;<a name="line.404"></a>
<span class="sourceLineNo">405</span>                                int b = in[inPos++];<a name="line.405"></a>
<span class="sourceLineNo">406</span>                                if (b &lt; 0) {<a name="line.406"></a>
<span class="sourceLineNo">407</span>                                        b += 256;<a name="line.407"></a>
<span class="sourceLineNo">408</span>                                }<a name="line.408"></a>
<span class="sourceLineNo">409</span>                                context.ibitWorkArea = (context.ibitWorkArea &lt;&lt; 8) + b; // BITS_PER_BYTE<a name="line.409"></a>
<span class="sourceLineNo">410</span>                                if (0 == context.modulus) { // 3 bytes = 24 bits = 4 * 6 bits to<a name="line.410"></a>
<span class="sourceLineNo">411</span>                                                                                        // extract<a name="line.411"></a>
<span class="sourceLineNo">412</span>                                        context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &gt;&gt; 18) &amp; MASK_6BITS];<a name="line.412"></a>
<span class="sourceLineNo">413</span>                                        context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &gt;&gt; 12) &amp; MASK_6BITS];<a name="line.413"></a>
<span class="sourceLineNo">414</span>                                        context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea &gt;&gt; 6) &amp; MASK_6BITS];<a name="line.414"></a>
<span class="sourceLineNo">415</span>                                        context.buffer[context.pos++] = encodeTable[context.ibitWorkArea &amp; MASK_6BITS];<a name="line.415"></a>
<span class="sourceLineNo">416</span>                                        context.currentLinePos += BYTES_PER_ENCODED_BLOCK;<a name="line.416"></a>
<span class="sourceLineNo">417</span>                                        if (lineLength &gt; 0 &amp;&amp; lineLength &lt;= context.currentLinePos) {<a name="line.417"></a>
<span class="sourceLineNo">418</span>                                                System.arraycopy(lineSeparator, 0, context.buffer, context.pos, lineSeparator.length);<a name="line.418"></a>
<span class="sourceLineNo">419</span>                                                context.pos += lineSeparator.length;<a name="line.419"></a>
<span class="sourceLineNo">420</span>                                                context.currentLinePos = 0;<a name="line.420"></a>
<span class="sourceLineNo">421</span>                                        }<a name="line.421"></a>
<span class="sourceLineNo">422</span>                                }<a name="line.422"></a>
<span class="sourceLineNo">423</span>                        }<a name="line.423"></a>
<span class="sourceLineNo">424</span>                }<a name="line.424"></a>
<span class="sourceLineNo">425</span>        }<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span>        /**<a name="line.427"></a>
<span class="sourceLineNo">428</span>         * &lt;p&gt;<a name="line.428"></a>
<span class="sourceLineNo">429</span>         * Decodes all of the provided data, starting at inPos, for inAvail bytes.<a name="line.429"></a>
<span class="sourceLineNo">430</span>         * Should be called at least twice: once with the data to decode, and once<a name="line.430"></a>
<span class="sourceLineNo">431</span>         * with inAvail set to "-1" to alert decoder that EOF has been reached. The<a name="line.431"></a>
<span class="sourceLineNo">432</span>         * "-1" call is not necessary when decoding, but it doesn't hurt, either.<a name="line.432"></a>
<span class="sourceLineNo">433</span>         * &lt;/p&gt;<a name="line.433"></a>
<span class="sourceLineNo">434</span>         * &lt;p&gt;<a name="line.434"></a>
<span class="sourceLineNo">435</span>         * Ignores all non-base64 characters. This is how chunked (e.g. 76<a name="line.435"></a>
<span class="sourceLineNo">436</span>         * character) data is handled, since CR and LF are silently ignored, but has<a name="line.436"></a>
<span class="sourceLineNo">437</span>         * implications for other bytes, too. This method subscribes to the<a name="line.437"></a>
<span class="sourceLineNo">438</span>         * garbage-in, garbage-out philosophy: it will not check the provided data<a name="line.438"></a>
<span class="sourceLineNo">439</span>         * for validity.<a name="line.439"></a>
<span class="sourceLineNo">440</span>         * &lt;/p&gt;<a name="line.440"></a>
<span class="sourceLineNo">441</span>         * &lt;p&gt;<a name="line.441"></a>
<span class="sourceLineNo">442</span>         * Thanks to "commons" project in ws.apache.org for the bitwise operations,<a name="line.442"></a>
<span class="sourceLineNo">443</span>         * and general approach.<a name="line.443"></a>
<span class="sourceLineNo">444</span>         * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/<a name="line.444"></a>
<span class="sourceLineNo">445</span>         * &lt;/p&gt;<a name="line.445"></a>
<span class="sourceLineNo">446</span>         * <a name="line.446"></a>
<span class="sourceLineNo">447</span>         * @param in<a name="line.447"></a>
<span class="sourceLineNo">448</span>         *            byte[] array of ascii data to base64 decode.<a name="line.448"></a>
<span class="sourceLineNo">449</span>         * @param inPos<a name="line.449"></a>
<span class="sourceLineNo">450</span>         *            Position to start reading data from.<a name="line.450"></a>
<span class="sourceLineNo">451</span>         * @param inAvail<a name="line.451"></a>
<span class="sourceLineNo">452</span>         *            Amount of bytes available from input for encoding.<a name="line.452"></a>
<span class="sourceLineNo">453</span>         * @param context<a name="line.453"></a>
<span class="sourceLineNo">454</span>         *            the context to be used<a name="line.454"></a>
<span class="sourceLineNo">455</span>         */<a name="line.455"></a>
<span class="sourceLineNo">456</span>        void decode(byte[] in, int inPos, int inAvail, Context context) {<a name="line.456"></a>
<span class="sourceLineNo">457</span>                if (context.eof) {<a name="line.457"></a>
<span class="sourceLineNo">458</span>                        return;<a name="line.458"></a>
<span class="sourceLineNo">459</span>                }<a name="line.459"></a>
<span class="sourceLineNo">460</span>                if (inAvail &lt; 0) {<a name="line.460"></a>
<span class="sourceLineNo">461</span>                        context.eof = true;<a name="line.461"></a>
<span class="sourceLineNo">462</span>                }<a name="line.462"></a>
<span class="sourceLineNo">463</span>                for (int i = 0; i &lt; inAvail; i++) {<a name="line.463"></a>
<span class="sourceLineNo">464</span>                        ensureBufferSize(decodeSize, context);<a name="line.464"></a>
<span class="sourceLineNo">465</span>                        byte b = in[inPos++];<a name="line.465"></a>
<span class="sourceLineNo">466</span>                        if (b == PAD) {<a name="line.466"></a>
<span class="sourceLineNo">467</span>                                // We're done.<a name="line.467"></a>
<span class="sourceLineNo">468</span>                                context.eof = true;<a name="line.468"></a>
<span class="sourceLineNo">469</span>                                break;<a name="line.469"></a>
<span class="sourceLineNo">470</span>                        } else {<a name="line.470"></a>
<span class="sourceLineNo">471</span>                                if (b &gt;= 0 &amp;&amp; b &lt; DECODE_TABLE.length) {<a name="line.471"></a>
<span class="sourceLineNo">472</span>                                        int result = DECODE_TABLE[b];<a name="line.472"></a>
<span class="sourceLineNo">473</span>                                        if (result &gt;= 0) {<a name="line.473"></a>
<span class="sourceLineNo">474</span>                                                context.modulus = (context.modulus + 1) % BYTES_PER_ENCODED_BLOCK;<a name="line.474"></a>
<span class="sourceLineNo">475</span>                                                context.ibitWorkArea = (context.ibitWorkArea &lt;&lt; BITS_PER_ENCODED_BYTE) + result;<a name="line.475"></a>
<span class="sourceLineNo">476</span>                                                if (context.modulus == 0) {<a name="line.476"></a>
<span class="sourceLineNo">477</span>                                                        context.buffer[context.pos++] = (byte) ((context.ibitWorkArea &gt;&gt; 16) &amp; MASK_8BITS);<a name="line.477"></a>
<span class="sourceLineNo">478</span>                                                        context.buffer[context.pos++] = (byte) ((context.ibitWorkArea &gt;&gt; 8) &amp; MASK_8BITS);<a name="line.478"></a>
<span class="sourceLineNo">479</span>                                                        context.buffer[context.pos++] = (byte) (context.ibitWorkArea &amp; MASK_8BITS);<a name="line.479"></a>
<span class="sourceLineNo">480</span>                                                }<a name="line.480"></a>
<span class="sourceLineNo">481</span>                                        }<a name="line.481"></a>
<span class="sourceLineNo">482</span>                                }<a name="line.482"></a>
<span class="sourceLineNo">483</span>                        }<a name="line.483"></a>
<span class="sourceLineNo">484</span>                }<a name="line.484"></a>
<span class="sourceLineNo">485</span><a name="line.485"></a>
<span class="sourceLineNo">486</span>                // Two forms of EOF as far as base64 decoder is concerned: actual<a name="line.486"></a>
<span class="sourceLineNo">487</span>                // EOF (-1) and first time '=' character is encountered in stream.<a name="line.487"></a>
<span class="sourceLineNo">488</span>                // This approach makes the '=' padding characters completely optional.<a name="line.488"></a>
<span class="sourceLineNo">489</span>                if (context.eof &amp;&amp; context.modulus != 0) {<a name="line.489"></a>
<span class="sourceLineNo">490</span>                        ensureBufferSize(decodeSize, context);<a name="line.490"></a>
<span class="sourceLineNo">491</span><a name="line.491"></a>
<span class="sourceLineNo">492</span>                        // We have some spare bits remaining<a name="line.492"></a>
<span class="sourceLineNo">493</span>                        // Output all whole multiples of 8 bits and ignore the rest<a name="line.493"></a>
<span class="sourceLineNo">494</span>                        switch (context.modulus) {<a name="line.494"></a>
<span class="sourceLineNo">495</span>                        // case 1: // 6 bits - ignore entirely<a name="line.495"></a>
<span class="sourceLineNo">496</span>                        // break;<a name="line.496"></a>
<span class="sourceLineNo">497</span>                        case 2: // 12 bits = 8 + 4<a name="line.497"></a>
<span class="sourceLineNo">498</span>                                context.ibitWorkArea = context.ibitWorkArea &gt;&gt; 4; // dump the<a name="line.498"></a>
<span class="sourceLineNo">499</span>                                                                                                                                        // extra 4<a name="line.499"></a>
<span class="sourceLineNo">500</span>                                                                                                                                        // bits<a name="line.500"></a>
<span class="sourceLineNo">501</span>                                context.buffer[context.pos++] = (byte) ((context.ibitWorkArea) &amp; MASK_8BITS);<a name="line.501"></a>
<span class="sourceLineNo">502</span>                                break;<a name="line.502"></a>
<span class="sourceLineNo">503</span>                        case 3: // 18 bits = 8 + 8 + 2<a name="line.503"></a>
<span class="sourceLineNo">504</span>                                context.ibitWorkArea = context.ibitWorkArea &gt;&gt; 2; // dump 2 bits<a name="line.504"></a>
<span class="sourceLineNo">505</span>                                context.buffer[context.pos++] = (byte) ((context.ibitWorkArea &gt;&gt; 8) &amp; MASK_8BITS);<a name="line.505"></a>
<span class="sourceLineNo">506</span>                                context.buffer[context.pos++] = (byte) ((context.ibitWorkArea) &amp; MASK_8BITS);<a name="line.506"></a>
<span class="sourceLineNo">507</span>                                break;<a name="line.507"></a>
<span class="sourceLineNo">508</span>                        }<a name="line.508"></a>
<span class="sourceLineNo">509</span>                }<a name="line.509"></a>
<span class="sourceLineNo">510</span>        }<a name="line.510"></a>
<span class="sourceLineNo">511</span><a name="line.511"></a>
<span class="sourceLineNo">512</span>        /**<a name="line.512"></a>
<span class="sourceLineNo">513</span>         * Tests a given byte array to see if it contains only valid characters<a name="line.513"></a>
<span class="sourceLineNo">514</span>         * within the Base64 alphabet. Currently the method treats whitespace as<a name="line.514"></a>
<span class="sourceLineNo">515</span>         * valid.<a name="line.515"></a>
<span class="sourceLineNo">516</span>         * <a name="line.516"></a>
<span class="sourceLineNo">517</span>         * @param arrayOctet<a name="line.517"></a>
<span class="sourceLineNo">518</span>         *            byte array to test<a name="line.518"></a>
<span class="sourceLineNo">519</span>         * @return {@code true} if all bytes are valid characters in the Base64<a name="line.519"></a>
<span class="sourceLineNo">520</span>         *         alphabet or if the byte array is empty; {@code false}, otherwise<a name="line.520"></a>
<span class="sourceLineNo">521</span>         * @deprecated 1.5 Use {@link #isBase64(byte[])}, will be removed in 2.0.<a name="line.521"></a>
<span class="sourceLineNo">522</span>         */<a name="line.522"></a>
<span class="sourceLineNo">523</span>        @Deprecated<a name="line.523"></a>
<span class="sourceLineNo">524</span>        public static boolean isArrayByteBase64(byte[] arrayOctet) {<a name="line.524"></a>
<span class="sourceLineNo">525</span>                return isBase64(arrayOctet);<a name="line.525"></a>
<span class="sourceLineNo">526</span>        }<a name="line.526"></a>
<span class="sourceLineNo">527</span><a name="line.527"></a>
<span class="sourceLineNo">528</span>        /**<a name="line.528"></a>
<span class="sourceLineNo">529</span>         * Returns whether or not the &lt;code&gt;octet&lt;/code&gt; is in the base 64 alphabet.<a name="line.529"></a>
<span class="sourceLineNo">530</span>         * <a name="line.530"></a>
<span class="sourceLineNo">531</span>         * @param octet<a name="line.531"></a>
<span class="sourceLineNo">532</span>         *            The value to test<a name="line.532"></a>
<span class="sourceLineNo">533</span>         * @return {@code true} if the value is defined in the the base 64 alphabet,<a name="line.533"></a>
<span class="sourceLineNo">534</span>         *         {@code false} otherwise.<a name="line.534"></a>
<span class="sourceLineNo">535</span>         * @since 1.4<a name="line.535"></a>
<span class="sourceLineNo">536</span>         */<a name="line.536"></a>
<span class="sourceLineNo">537</span>        public static boolean isBase64(byte octet) {<a name="line.537"></a>
<span class="sourceLineNo">538</span>                return octet == PAD_DEFAULT || (octet &gt;= 0 &amp;&amp; octet &lt; DECODE_TABLE.length &amp;&amp; DECODE_TABLE[octet] != -1);<a name="line.538"></a>
<span class="sourceLineNo">539</span>        }<a name="line.539"></a>
<span class="sourceLineNo">540</span><a name="line.540"></a>
<span class="sourceLineNo">541</span>        /**<a name="line.541"></a>
<span class="sourceLineNo">542</span>         * Tests a given String to see if it contains only valid characters within<a name="line.542"></a>
<span class="sourceLineNo">543</span>         * the Base64 alphabet. Currently the method treats whitespace as valid.<a name="line.543"></a>
<span class="sourceLineNo">544</span>         * <a name="line.544"></a>
<span class="sourceLineNo">545</span>         * @param base64<a name="line.545"></a>
<span class="sourceLineNo">546</span>         *            String to test<a name="line.546"></a>
<span class="sourceLineNo">547</span>         * @return {@code true} if all characters in the String are valid characters<a name="line.547"></a>
<span class="sourceLineNo">548</span>         *         in the Base64 alphabet or if the String is empty; {@code false},<a name="line.548"></a>
<span class="sourceLineNo">549</span>         *         otherwise<a name="line.549"></a>
<span class="sourceLineNo">550</span>         * @since 1.5<a name="line.550"></a>
<span class="sourceLineNo">551</span>         */<a name="line.551"></a>
<span class="sourceLineNo">552</span>        public static boolean isBase64(String base64) {<a name="line.552"></a>
<span class="sourceLineNo">553</span>                return isBase64(StringUtils.getBytesUtf8(base64));<a name="line.553"></a>
<span class="sourceLineNo">554</span>        }<a name="line.554"></a>
<span class="sourceLineNo">555</span><a name="line.555"></a>
<span class="sourceLineNo">556</span>        /**<a name="line.556"></a>
<span class="sourceLineNo">557</span>         * Tests a given byte array to see if it contains only valid characters<a name="line.557"></a>
<span class="sourceLineNo">558</span>         * within the Base64 alphabet. Currently the method treats whitespace as<a name="line.558"></a>
<span class="sourceLineNo">559</span>         * valid.<a name="line.559"></a>
<span class="sourceLineNo">560</span>         * <a name="line.560"></a>
<span class="sourceLineNo">561</span>         * @param arrayOctet<a name="line.561"></a>
<span class="sourceLineNo">562</span>         *            byte array to test<a name="line.562"></a>
<span class="sourceLineNo">563</span>         * @return {@code true} if all bytes are valid characters in the Base64<a name="line.563"></a>
<span class="sourceLineNo">564</span>         *         alphabet or if the byte array is empty; {@code false}, otherwise<a name="line.564"></a>
<span class="sourceLineNo">565</span>         * @since 1.5<a name="line.565"></a>
<span class="sourceLineNo">566</span>         */<a name="line.566"></a>
<span class="sourceLineNo">567</span>        public static boolean isBase64(byte[] arrayOctet) {<a name="line.567"></a>
<span class="sourceLineNo">568</span>                for (int i = 0; i &lt; arrayOctet.length; i++) {<a name="line.568"></a>
<span class="sourceLineNo">569</span>                        if (!isBase64(arrayOctet[i]) &amp;&amp; !isWhiteSpace(arrayOctet[i])) {<a name="line.569"></a>
<span class="sourceLineNo">570</span>                                return false;<a name="line.570"></a>
<span class="sourceLineNo">571</span>                        }<a name="line.571"></a>
<span class="sourceLineNo">572</span>                }<a name="line.572"></a>
<span class="sourceLineNo">573</span>                return true;<a name="line.573"></a>
<span class="sourceLineNo">574</span>        }<a name="line.574"></a>
<span class="sourceLineNo">575</span><a name="line.575"></a>
<span class="sourceLineNo">576</span>        /**<a name="line.576"></a>
<span class="sourceLineNo">577</span>         * Encodes binary data using the base64 algorithm but does not chunk the<a name="line.577"></a>
<span class="sourceLineNo">578</span>         * output.<a name="line.578"></a>
<span class="sourceLineNo">579</span>         * <a name="line.579"></a>
<span class="sourceLineNo">580</span>         * @param binaryData<a name="line.580"></a>
<span class="sourceLineNo">581</span>         *            binary data to encode<a name="line.581"></a>
<span class="sourceLineNo">582</span>         * @return byte[] containing Base64 characters in their UTF-8<a name="line.582"></a>
<span class="sourceLineNo">583</span>         *         representation.<a name="line.583"></a>
<span class="sourceLineNo">584</span>         */<a name="line.584"></a>
<span class="sourceLineNo">585</span>        public static byte[] encodeBase64(byte[] binaryData) {<a name="line.585"></a>
<span class="sourceLineNo">586</span>                return encodeBase64(binaryData, false);<a name="line.586"></a>
<span class="sourceLineNo">587</span>        }<a name="line.587"></a>
<span class="sourceLineNo">588</span><a name="line.588"></a>
<span class="sourceLineNo">589</span>        /**<a name="line.589"></a>
<span class="sourceLineNo">590</span>         * Encodes binary data using the base64 algorithm but does not chunk the<a name="line.590"></a>
<span class="sourceLineNo">591</span>         * output.<a name="line.591"></a>
<span class="sourceLineNo">592</span>         * <a name="line.592"></a>
<span class="sourceLineNo">593</span>         * NOTE: We changed the behaviour of this method from multi-line chunking<a name="line.593"></a>
<span class="sourceLineNo">594</span>         * (commons-codec-1.4) to single-line non-chunking (commons-codec-1.5).<a name="line.594"></a>
<span class="sourceLineNo">595</span>         * <a name="line.595"></a>
<span class="sourceLineNo">596</span>         * @param binaryData<a name="line.596"></a>
<span class="sourceLineNo">597</span>         *            binary data to encode<a name="line.597"></a>
<span class="sourceLineNo">598</span>         * @return String containing Base64 characters.<a name="line.598"></a>
<span class="sourceLineNo">599</span>         * @since 1.4 (NOTE: 1.4 chunked the output, whereas 1.5 does not).<a name="line.599"></a>
<span class="sourceLineNo">600</span>         */<a name="line.600"></a>
<span class="sourceLineNo">601</span>        public static String encodeBase64String(byte[] binaryData) {<a name="line.601"></a>
<span class="sourceLineNo">602</span>                return StringUtils.newStringUtf8(encodeBase64(binaryData, false));<a name="line.602"></a>
<span class="sourceLineNo">603</span>        }<a name="line.603"></a>
<span class="sourceLineNo">604</span><a name="line.604"></a>
<span class="sourceLineNo">605</span>        /**<a name="line.605"></a>
<span class="sourceLineNo">606</span>         * Encodes binary data using a URL-safe variation of the base64 algorithm<a name="line.606"></a>
<span class="sourceLineNo">607</span>         * but does not chunk the output. The url-safe variation emits - and _<a name="line.607"></a>
<span class="sourceLineNo">608</span>         * instead of + and / characters.<a name="line.608"></a>
<span class="sourceLineNo">609</span>         * <a name="line.609"></a>
<span class="sourceLineNo">610</span>         * @param binaryData<a name="line.610"></a>
<span class="sourceLineNo">611</span>         *            binary data to encode<a name="line.611"></a>
<span class="sourceLineNo">612</span>         * @return byte[] containing Base64 characters in their UTF-8<a name="line.612"></a>
<span class="sourceLineNo">613</span>         *         representation.<a name="line.613"></a>
<span class="sourceLineNo">614</span>         * @since 1.4<a name="line.614"></a>
<span class="sourceLineNo">615</span>         */<a name="line.615"></a>
<span class="sourceLineNo">616</span>        public static byte[] encodeBase64URLSafe(byte[] binaryData) {<a name="line.616"></a>
<span class="sourceLineNo">617</span>                return encodeBase64(binaryData, false, true);<a name="line.617"></a>
<span class="sourceLineNo">618</span>        }<a name="line.618"></a>
<span class="sourceLineNo">619</span><a name="line.619"></a>
<span class="sourceLineNo">620</span>        /**<a name="line.620"></a>
<span class="sourceLineNo">621</span>         * Encodes binary data using a URL-safe variation of the base64 algorithm<a name="line.621"></a>
<span class="sourceLineNo">622</span>         * but does not chunk the output. The url-safe variation emits - and _<a name="line.622"></a>
<span class="sourceLineNo">623</span>         * instead of + and / characters.<a name="line.623"></a>
<span class="sourceLineNo">624</span>         * <a name="line.624"></a>
<span class="sourceLineNo">625</span>         * @param binaryData<a name="line.625"></a>
<span class="sourceLineNo">626</span>         *            binary data to encode<a name="line.626"></a>
<span class="sourceLineNo">627</span>         * @return String containing Base64 characters<a name="line.627"></a>
<span class="sourceLineNo">628</span>         * @since 1.4<a name="line.628"></a>
<span class="sourceLineNo">629</span>         */<a name="line.629"></a>
<span class="sourceLineNo">630</span>        public static String encodeBase64URLSafeString(byte[] binaryData) {<a name="line.630"></a>
<span class="sourceLineNo">631</span>                return StringUtils.newStringUtf8(encodeBase64(binaryData, false, true));<a name="line.631"></a>
<span class="sourceLineNo">632</span>        }<a name="line.632"></a>
<span class="sourceLineNo">633</span><a name="line.633"></a>
<span class="sourceLineNo">634</span>        /**<a name="line.634"></a>
<span class="sourceLineNo">635</span>         * Encodes binary data using the base64 algorithm and chunks the encoded<a name="line.635"></a>
<span class="sourceLineNo">636</span>         * output into 76 character blocks<a name="line.636"></a>
<span class="sourceLineNo">637</span>         * <a name="line.637"></a>
<span class="sourceLineNo">638</span>         * @param binaryData<a name="line.638"></a>
<span class="sourceLineNo">639</span>         *            binary data to encode<a name="line.639"></a>
<span class="sourceLineNo">640</span>         * @return Base64 characters chunked in 76 character blocks<a name="line.640"></a>
<span class="sourceLineNo">641</span>         */<a name="line.641"></a>
<span class="sourceLineNo">642</span>        public static byte[] encodeBase64Chunked(byte[] binaryData) {<a name="line.642"></a>
<span class="sourceLineNo">643</span>                return encodeBase64(binaryData, true);<a name="line.643"></a>
<span class="sourceLineNo">644</span>        }<a name="line.644"></a>
<span class="sourceLineNo">645</span><a name="line.645"></a>
<span class="sourceLineNo">646</span>        /**<a name="line.646"></a>
<span class="sourceLineNo">647</span>         * Encodes binary data using the base64 algorithm, optionally chunking the<a name="line.647"></a>
<span class="sourceLineNo">648</span>         * output into 76 character blocks.<a name="line.648"></a>
<span class="sourceLineNo">649</span>         * <a name="line.649"></a>
<span class="sourceLineNo">650</span>         * @param binaryData<a name="line.650"></a>
<span class="sourceLineNo">651</span>         *            Array containing binary data to encode.<a name="line.651"></a>
<span class="sourceLineNo">652</span>         * @param isChunked<a name="line.652"></a>
<span class="sourceLineNo">653</span>         *            if {@code true} this encoder will chunk the base64 output into<a name="line.653"></a>
<span class="sourceLineNo">654</span>         *            76 character blocks<a name="line.654"></a>
<span class="sourceLineNo">655</span>         * @return Base64-encoded data.<a name="line.655"></a>
<span class="sourceLineNo">656</span>         * @throws IllegalArgumentException<a name="line.656"></a>
<span class="sourceLineNo">657</span>         *             Thrown when the input array needs an output array bigger than<a name="line.657"></a>
<span class="sourceLineNo">658</span>         *             {@link Integer#MAX_VALUE}<a name="line.658"></a>
<span class="sourceLineNo">659</span>         */<a name="line.659"></a>
<span class="sourceLineNo">660</span>        public static byte[] encodeBase64(byte[] binaryData, boolean isChunked) {<a name="line.660"></a>
<span class="sourceLineNo">661</span>                return encodeBase64(binaryData, isChunked, false);<a name="line.661"></a>
<span class="sourceLineNo">662</span>        }<a name="line.662"></a>
<span class="sourceLineNo">663</span><a name="line.663"></a>
<span class="sourceLineNo">664</span>        /**<a name="line.664"></a>
<span class="sourceLineNo">665</span>         * Encodes binary data using the base64 algorithm, optionally chunking the<a name="line.665"></a>
<span class="sourceLineNo">666</span>         * output into 76 character blocks.<a name="line.666"></a>
<span class="sourceLineNo">667</span>         * <a name="line.667"></a>
<span class="sourceLineNo">668</span>         * @param binaryData<a name="line.668"></a>
<span class="sourceLineNo">669</span>         *            Array containing binary data to encode.<a name="line.669"></a>
<span class="sourceLineNo">670</span>         * @param isChunked<a name="line.670"></a>
<span class="sourceLineNo">671</span>         *            if {@code true} this encoder will chunk the base64 output into<a name="line.671"></a>
<span class="sourceLineNo">672</span>         *            76 character blocks<a name="line.672"></a>
<span class="sourceLineNo">673</span>         * @param urlSafe<a name="line.673"></a>
<span class="sourceLineNo">674</span>         *            if {@code true} this encoder will emit - and _ instead of the<a name="line.674"></a>
<span class="sourceLineNo">675</span>         *            usual + and / characters.<a name="line.675"></a>
<span class="sourceLineNo">676</span>         * @return Base64-encoded data.<a name="line.676"></a>
<span class="sourceLineNo">677</span>         * @throws IllegalArgumentException<a name="line.677"></a>
<span class="sourceLineNo">678</span>         *             Thrown when the input array needs an output array bigger than<a name="line.678"></a>
<span class="sourceLineNo">679</span>         *             {@link Integer#MAX_VALUE}<a name="line.679"></a>
<span class="sourceLineNo">680</span>         * @since 1.4<a name="line.680"></a>
<span class="sourceLineNo">681</span>         */<a name="line.681"></a>
<span class="sourceLineNo">682</span>        public static byte[] encodeBase64(byte[] binaryData, boolean isChunked, boolean urlSafe) {<a name="line.682"></a>
<span class="sourceLineNo">683</span>                return encodeBase64(binaryData, isChunked, urlSafe, Integer.MAX_VALUE);<a name="line.683"></a>
<span class="sourceLineNo">684</span>        }<a name="line.684"></a>
<span class="sourceLineNo">685</span><a name="line.685"></a>
<span class="sourceLineNo">686</span>        /**<a name="line.686"></a>
<span class="sourceLineNo">687</span>         * Encodes binary data using the base64 algorithm, optionally chunking the<a name="line.687"></a>
<span class="sourceLineNo">688</span>         * output into 76 character blocks.<a name="line.688"></a>
<span class="sourceLineNo">689</span>         * <a name="line.689"></a>
<span class="sourceLineNo">690</span>         * @param binaryData<a name="line.690"></a>
<span class="sourceLineNo">691</span>         *            Array containing binary data to encode.<a name="line.691"></a>
<span class="sourceLineNo">692</span>         * @param isChunked<a name="line.692"></a>
<span class="sourceLineNo">693</span>         *            if {@code true} this encoder will chunk the base64 output into<a name="line.693"></a>
<span class="sourceLineNo">694</span>         *            76 character blocks<a name="line.694"></a>
<span class="sourceLineNo">695</span>         * @param urlSafe<a name="line.695"></a>
<span class="sourceLineNo">696</span>         *            if {@code true} this encoder will emit - and _ instead of the<a name="line.696"></a>
<span class="sourceLineNo">697</span>         *            usual + and / characters.<a name="line.697"></a>
<span class="sourceLineNo">698</span>         * @param maxResultSize<a name="line.698"></a>
<span class="sourceLineNo">699</span>         *            The maximum result size to accept.<a name="line.699"></a>
<span class="sourceLineNo">700</span>         * @return Base64-encoded data.<a name="line.700"></a>
<span class="sourceLineNo">701</span>         * @throws IllegalArgumentException<a name="line.701"></a>
<span class="sourceLineNo">702</span>         *             Thrown when the input array needs an output array bigger than<a name="line.702"></a>
<span class="sourceLineNo">703</span>         *             maxResultSize<a name="line.703"></a>
<span class="sourceLineNo">704</span>         * @since 1.4<a name="line.704"></a>
<span class="sourceLineNo">705</span>         */<a name="line.705"></a>
<span class="sourceLineNo">706</span>        public static byte[] encodeBase64(byte[] binaryData, boolean isChunked, boolean urlSafe, int maxResultSize) {<a name="line.706"></a>
<span class="sourceLineNo">707</span>                if (binaryData == null || binaryData.length == 0) {<a name="line.707"></a>
<span class="sourceLineNo">708</span>                        return binaryData;<a name="line.708"></a>
<span class="sourceLineNo">709</span>                }<a name="line.709"></a>
<span class="sourceLineNo">710</span><a name="line.710"></a>
<span class="sourceLineNo">711</span>                // Create this so can use the super-class method<a name="line.711"></a>
<span class="sourceLineNo">712</span>                // Also ensures that the same roundings are performed by the ctor and<a name="line.712"></a>
<span class="sourceLineNo">713</span>                // the code<a name="line.713"></a>
<span class="sourceLineNo">714</span>                Base64 b64 = isChunked ? new Base64(urlSafe) : new Base64(0, CHUNK_SEPARATOR, urlSafe);<a name="line.714"></a>
<span class="sourceLineNo">715</span>                long len = b64.getEncodedLength(binaryData);<a name="line.715"></a>
<span class="sourceLineNo">716</span>                if (len &gt; maxResultSize) {<a name="line.716"></a>
<span class="sourceLineNo">717</span>                        throw new IllegalArgumentException("Input array too big, the output array would be bigger (" + len + ") than the specified maximum size of " + maxResultSize);<a name="line.717"></a>
<span class="sourceLineNo">718</span>                }<a name="line.718"></a>
<span class="sourceLineNo">719</span><a name="line.719"></a>
<span class="sourceLineNo">720</span>                return b64.encode(binaryData);<a name="line.720"></a>
<span class="sourceLineNo">721</span>        }<a name="line.721"></a>
<span class="sourceLineNo">722</span><a name="line.722"></a>
<span class="sourceLineNo">723</span>        /**<a name="line.723"></a>
<span class="sourceLineNo">724</span>         * Decodes a Base64 String into octets<a name="line.724"></a>
<span class="sourceLineNo">725</span>         * <a name="line.725"></a>
<span class="sourceLineNo">726</span>         * @param base64String<a name="line.726"></a>
<span class="sourceLineNo">727</span>         *            String containing Base64 data<a name="line.727"></a>
<span class="sourceLineNo">728</span>         * @return Array containing decoded data.<a name="line.728"></a>
<span class="sourceLineNo">729</span>         * @since 1.4<a name="line.729"></a>
<span class="sourceLineNo">730</span>         */<a name="line.730"></a>
<span class="sourceLineNo">731</span>        public static byte[] decodeBase64(String base64String) {<a name="line.731"></a>
<span class="sourceLineNo">732</span>                return new Base64().decode(base64String);<a name="line.732"></a>
<span class="sourceLineNo">733</span>        }<a name="line.733"></a>
<span class="sourceLineNo">734</span><a name="line.734"></a>
<span class="sourceLineNo">735</span>        /**<a name="line.735"></a>
<span class="sourceLineNo">736</span>         * Decodes Base64 data into octets<a name="line.736"></a>
<span class="sourceLineNo">737</span>         * <a name="line.737"></a>
<span class="sourceLineNo">738</span>         * @param base64Data<a name="line.738"></a>
<span class="sourceLineNo">739</span>         *            Byte array containing Base64 data<a name="line.739"></a>
<span class="sourceLineNo">740</span>         * @return Array containing decoded data.<a name="line.740"></a>
<span class="sourceLineNo">741</span>         */<a name="line.741"></a>
<span class="sourceLineNo">742</span>        public static byte[] decodeBase64(byte[] base64Data) {<a name="line.742"></a>
<span class="sourceLineNo">743</span>                return new Base64().decode(base64Data);<a name="line.743"></a>
<span class="sourceLineNo">744</span>        }<a name="line.744"></a>
<span class="sourceLineNo">745</span><a name="line.745"></a>
<span class="sourceLineNo">746</span>        // Implementation of the Encoder Interface<a name="line.746"></a>
<span class="sourceLineNo">747</span><a name="line.747"></a>
<span class="sourceLineNo">748</span>        // Implementation of integer encoding used for crypto<a name="line.748"></a>
<span class="sourceLineNo">749</span>        /**<a name="line.749"></a>
<span class="sourceLineNo">750</span>         * Decodes a byte64-encoded integer according to crypto standards such as<a name="line.750"></a>
<span class="sourceLineNo">751</span>         * W3C's XML-Signature<a name="line.751"></a>
<span class="sourceLineNo">752</span>         * <a name="line.752"></a>
<span class="sourceLineNo">753</span>         * @param pArray<a name="line.753"></a>
<span class="sourceLineNo">754</span>         *            a byte array containing base64 character data<a name="line.754"></a>
<span class="sourceLineNo">755</span>         * @return A BigInteger<a name="line.755"></a>
<span class="sourceLineNo">756</span>         * @since 1.4<a name="line.756"></a>
<span class="sourceLineNo">757</span>         */<a name="line.757"></a>
<span class="sourceLineNo">758</span>        public static BigInteger decodeInteger(byte[] pArray) {<a name="line.758"></a>
<span class="sourceLineNo">759</span>                return new BigInteger(1, decodeBase64(pArray));<a name="line.759"></a>
<span class="sourceLineNo">760</span>        }<a name="line.760"></a>
<span class="sourceLineNo">761</span><a name="line.761"></a>
<span class="sourceLineNo">762</span>        /**<a name="line.762"></a>
<span class="sourceLineNo">763</span>         * Encodes to a byte64-encoded integer according to crypto standards such as<a name="line.763"></a>
<span class="sourceLineNo">764</span>         * W3C's XML-Signature<a name="line.764"></a>
<span class="sourceLineNo">765</span>         * <a name="line.765"></a>
<span class="sourceLineNo">766</span>         * @param bigInt<a name="line.766"></a>
<span class="sourceLineNo">767</span>         *            a BigInteger<a name="line.767"></a>
<span class="sourceLineNo">768</span>         * @return A byte array containing base64 character data<a name="line.768"></a>
<span class="sourceLineNo">769</span>         * @throws NullPointerException<a name="line.769"></a>
<span class="sourceLineNo">770</span>         *             if null is passed in<a name="line.770"></a>
<span class="sourceLineNo">771</span>         * @since 1.4<a name="line.771"></a>
<span class="sourceLineNo">772</span>         */<a name="line.772"></a>
<span class="sourceLineNo">773</span>        public static byte[] encodeInteger(BigInteger bigInt) {<a name="line.773"></a>
<span class="sourceLineNo">774</span>                if (bigInt == null) {<a name="line.774"></a>
<span class="sourceLineNo">775</span>                        throw new NullPointerException("encodeInteger called with null parameter");<a name="line.775"></a>
<span class="sourceLineNo">776</span>                }<a name="line.776"></a>
<span class="sourceLineNo">777</span>                return encodeBase64(toIntegerBytes(bigInt), false);<a name="line.777"></a>
<span class="sourceLineNo">778</span>        }<a name="line.778"></a>
<span class="sourceLineNo">779</span><a name="line.779"></a>
<span class="sourceLineNo">780</span>        /**<a name="line.780"></a>
<span class="sourceLineNo">781</span>         * Returns a byte-array representation of a &lt;code&gt;BigInteger&lt;/code&gt; without<a name="line.781"></a>
<span class="sourceLineNo">782</span>         * sign bit.<a name="line.782"></a>
<span class="sourceLineNo">783</span>         * <a name="line.783"></a>
<span class="sourceLineNo">784</span>         * @param bigInt<a name="line.784"></a>
<span class="sourceLineNo">785</span>         *            &lt;code&gt;BigInteger&lt;/code&gt; to be converted<a name="line.785"></a>
<span class="sourceLineNo">786</span>         * @return a byte array representation of the BigInteger parameter<a name="line.786"></a>
<span class="sourceLineNo">787</span>         */<a name="line.787"></a>
<span class="sourceLineNo">788</span>        static byte[] toIntegerBytes(BigInteger bigInt) {<a name="line.788"></a>
<span class="sourceLineNo">789</span>                int bitlen = bigInt.bitLength();<a name="line.789"></a>
<span class="sourceLineNo">790</span>                // round bitlen<a name="line.790"></a>
<span class="sourceLineNo">791</span>                bitlen = ((bitlen + 7) &gt;&gt; 3) &lt;&lt; 3;<a name="line.791"></a>
<span class="sourceLineNo">792</span>                byte[] bigBytes = bigInt.toByteArray();<a name="line.792"></a>
<span class="sourceLineNo">793</span><a name="line.793"></a>
<span class="sourceLineNo">794</span>                if (((bigInt.bitLength() % 8) != 0) &amp;&amp; (((bigInt.bitLength() / 8) + 1) == (bitlen / 8))) {<a name="line.794"></a>
<span class="sourceLineNo">795</span>                        return bigBytes;<a name="line.795"></a>
<span class="sourceLineNo">796</span>                }<a name="line.796"></a>
<span class="sourceLineNo">797</span>                // set up params for copying everything but sign bit<a name="line.797"></a>
<span class="sourceLineNo">798</span>                int startSrc = 0;<a name="line.798"></a>
<span class="sourceLineNo">799</span>                int len = bigBytes.length;<a name="line.799"></a>
<span class="sourceLineNo">800</span><a name="line.800"></a>
<span class="sourceLineNo">801</span>                // if bigInt is exactly byte-aligned, just skip signbit in copy<a name="line.801"></a>
<span class="sourceLineNo">802</span>                if ((bigInt.bitLength() % 8) == 0) {<a name="line.802"></a>
<span class="sourceLineNo">803</span>                        startSrc = 1;<a name="line.803"></a>
<span class="sourceLineNo">804</span>                        len--;<a name="line.804"></a>
<span class="sourceLineNo">805</span>                }<a name="line.805"></a>
<span class="sourceLineNo">806</span>                int startDst = bitlen / 8 - len; // to pad w/ nulls as per spec<a name="line.806"></a>
<span class="sourceLineNo">807</span>                byte[] resizedBytes = new byte[bitlen / 8];<a name="line.807"></a>
<span class="sourceLineNo">808</span>                System.arraycopy(bigBytes, startSrc, resizedBytes, startDst, len);<a name="line.808"></a>
<span class="sourceLineNo">809</span>                return resizedBytes;<a name="line.809"></a>
<span class="sourceLineNo">810</span>        }<a name="line.810"></a>
<span class="sourceLineNo">811</span><a name="line.811"></a>
<span class="sourceLineNo">812</span>        /**<a name="line.812"></a>
<span class="sourceLineNo">813</span>         * Returns whether or not the &lt;code&gt;octet&lt;/code&gt; is in the Base32 alphabet.<a name="line.813"></a>
<span class="sourceLineNo">814</span>         * <a name="line.814"></a>
<span class="sourceLineNo">815</span>         * @param octet<a name="line.815"></a>
<span class="sourceLineNo">816</span>         *            The value to test<a name="line.816"></a>
<span class="sourceLineNo">817</span>         * @return {@code true} if the value is defined in the the Base32 alphabet<a name="line.817"></a>
<span class="sourceLineNo">818</span>         *         {@code false} otherwise.<a name="line.818"></a>
<span class="sourceLineNo">819</span>         */<a name="line.819"></a>
<span class="sourceLineNo">820</span>        protected boolean isInAlphabet(byte octet) {<a name="line.820"></a>
<span class="sourceLineNo">821</span>                return octet &gt;= 0 &amp;&amp; octet &lt; decodeTable.length &amp;&amp; decodeTable[octet] != -1;<a name="line.821"></a>
<span class="sourceLineNo">822</span>        }<a name="line.822"></a>
<span class="sourceLineNo">823</span><a name="line.823"></a>
<span class="sourceLineNo">824</span>        /**<a name="line.824"></a>
<span class="sourceLineNo">825</span>         * Holds thread context so classes can be thread-safe.<a name="line.825"></a>
<span class="sourceLineNo">826</span>         * <a name="line.826"></a>
<span class="sourceLineNo">827</span>         * This class is not itself thread-safe; each thread must allocate its own<a name="line.827"></a>
<span class="sourceLineNo">828</span>         * copy.<a name="line.828"></a>
<span class="sourceLineNo">829</span>         * <a name="line.829"></a>
<span class="sourceLineNo">830</span>         * @since 1.7<a name="line.830"></a>
<span class="sourceLineNo">831</span>         */<a name="line.831"></a>
<span class="sourceLineNo">832</span>        static class Context {<a name="line.832"></a>
<span class="sourceLineNo">833</span><a name="line.833"></a>
<span class="sourceLineNo">834</span>                /**<a name="line.834"></a>
<span class="sourceLineNo">835</span>                 * Place holder for the bytes we're dealing with for our based logic.<a name="line.835"></a>
<span class="sourceLineNo">836</span>                 * Bitwise operations store and extract the encoding or decoding from<a name="line.836"></a>
<span class="sourceLineNo">837</span>                 * this variable.<a name="line.837"></a>
<span class="sourceLineNo">838</span>                 */<a name="line.838"></a>
<span class="sourceLineNo">839</span>                int ibitWorkArea;<a name="line.839"></a>
<span class="sourceLineNo">840</span><a name="line.840"></a>
<span class="sourceLineNo">841</span>                /**<a name="line.841"></a>
<span class="sourceLineNo">842</span>                 * Place holder for the bytes we're dealing with for our based logic.<a name="line.842"></a>
<span class="sourceLineNo">843</span>                 * Bitwise operations store and extract the encoding or decoding from<a name="line.843"></a>
<span class="sourceLineNo">844</span>                 * this variable.<a name="line.844"></a>
<span class="sourceLineNo">845</span>                 */<a name="line.845"></a>
<span class="sourceLineNo">846</span>                long lbitWorkArea;<a name="line.846"></a>
<span class="sourceLineNo">847</span><a name="line.847"></a>
<span class="sourceLineNo">848</span>                /**<a name="line.848"></a>
<span class="sourceLineNo">849</span>                 * Buffer for streaming.<a name="line.849"></a>
<span class="sourceLineNo">850</span>                 */<a name="line.850"></a>
<span class="sourceLineNo">851</span>                byte[] buffer;<a name="line.851"></a>
<span class="sourceLineNo">852</span><a name="line.852"></a>
<span class="sourceLineNo">853</span>                /**<a name="line.853"></a>
<span class="sourceLineNo">854</span>                 * Position where next character should be written in the buffer.<a name="line.854"></a>
<span class="sourceLineNo">855</span>                 */<a name="line.855"></a>
<span class="sourceLineNo">856</span>                int pos;<a name="line.856"></a>
<span class="sourceLineNo">857</span><a name="line.857"></a>
<span class="sourceLineNo">858</span>                /**<a name="line.858"></a>
<span class="sourceLineNo">859</span>                 * Position where next character should be read from the buffer.<a name="line.859"></a>
<span class="sourceLineNo">860</span>                 */<a name="line.860"></a>
<span class="sourceLineNo">861</span>                int readPos;<a name="line.861"></a>
<span class="sourceLineNo">862</span><a name="line.862"></a>
<span class="sourceLineNo">863</span>                /**<a name="line.863"></a>
<span class="sourceLineNo">864</span>                 * Boolean flag to indicate the EOF has been reached. Once EOF has been<a name="line.864"></a>
<span class="sourceLineNo">865</span>                 * reached, this object becomes useless, and must be thrown away.<a name="line.865"></a>
<span class="sourceLineNo">866</span>                 */<a name="line.866"></a>
<span class="sourceLineNo">867</span>                boolean eof;<a name="line.867"></a>
<span class="sourceLineNo">868</span><a name="line.868"></a>
<span class="sourceLineNo">869</span>                /**<a name="line.869"></a>
<span class="sourceLineNo">870</span>                 * Variable tracks how many characters have been written to the current<a name="line.870"></a>
<span class="sourceLineNo">871</span>                 * line. Only used when encoding. We use it to make sure each encoded<a name="line.871"></a>
<span class="sourceLineNo">872</span>                 * line never goes beyond lineLength (if lineLength &gt; 0).<a name="line.872"></a>
<span class="sourceLineNo">873</span>                 */<a name="line.873"></a>
<span class="sourceLineNo">874</span>                int currentLinePos;<a name="line.874"></a>
<span class="sourceLineNo">875</span><a name="line.875"></a>
<span class="sourceLineNo">876</span>                /**<a name="line.876"></a>
<span class="sourceLineNo">877</span>                 * Writes to the buffer only occur after every 3/5 reads when encoding,<a name="line.877"></a>
<span class="sourceLineNo">878</span>                 * and every 4/8 reads when decoding. This variable helps track that.<a name="line.878"></a>
<span class="sourceLineNo">879</span>                 */<a name="line.879"></a>
<span class="sourceLineNo">880</span>                int modulus;<a name="line.880"></a>
<span class="sourceLineNo">881</span><a name="line.881"></a>
<span class="sourceLineNo">882</span>                Context() {<a name="line.882"></a>
<span class="sourceLineNo">883</span>                }<a name="line.883"></a>
<span class="sourceLineNo">884</span>        }<a name="line.884"></a>
<span class="sourceLineNo">885</span><a name="line.885"></a>
<span class="sourceLineNo">886</span>        /**<a name="line.886"></a>
<span class="sourceLineNo">887</span>         * EOF<a name="line.887"></a>
<span class="sourceLineNo">888</span>         * <a name="line.888"></a>
<span class="sourceLineNo">889</span>         * @since 1.7<a name="line.889"></a>
<span class="sourceLineNo">890</span>         */<a name="line.890"></a>
<span class="sourceLineNo">891</span>        static final int EOF = -1;<a name="line.891"></a>
<span class="sourceLineNo">892</span><a name="line.892"></a>
<span class="sourceLineNo">893</span>        /**<a name="line.893"></a>
<span class="sourceLineNo">894</span>         * MIME chunk size per RFC 2045 section 6.8.<a name="line.894"></a>
<span class="sourceLineNo">895</span>         * <a name="line.895"></a>
<span class="sourceLineNo">896</span>         * &lt;p&gt;<a name="line.896"></a>
<span class="sourceLineNo">897</span>         * The {@value} character limit does not count the trailing CRLF, but counts<a name="line.897"></a>
<span class="sourceLineNo">898</span>         * all other characters, including any equal signs.<a name="line.898"></a>
<span class="sourceLineNo">899</span>         * &lt;/p&gt;<a name="line.899"></a>
<span class="sourceLineNo">900</span>         * <a name="line.900"></a>
<span class="sourceLineNo">901</span>         * @see &lt;a href="http://www.ietf.org/rfc/rfc2045.txt"&gt;RFC 2045 section<a name="line.901"></a>
<span class="sourceLineNo">902</span>         *      6.8&lt;/a&gt;<a name="line.902"></a>
<span class="sourceLineNo">903</span>         */<a name="line.903"></a>
<span class="sourceLineNo">904</span>        public static final int MIME_CHUNK_SIZE = 76;<a name="line.904"></a>
<span class="sourceLineNo">905</span><a name="line.905"></a>
<span class="sourceLineNo">906</span>        /**<a name="line.906"></a>
<span class="sourceLineNo">907</span>         * PEM chunk size per RFC 1421 section 4.3.2.4.<a name="line.907"></a>
<span class="sourceLineNo">908</span>         * <a name="line.908"></a>
<span class="sourceLineNo">909</span>         * &lt;p&gt;<a name="line.909"></a>
<span class="sourceLineNo">910</span>         * The {@value} character limit does not count the trailing CRLF, but counts<a name="line.910"></a>
<span class="sourceLineNo">911</span>         * all other characters, including any equal signs.<a name="line.911"></a>
<span class="sourceLineNo">912</span>         * &lt;/p&gt;<a name="line.912"></a>
<span class="sourceLineNo">913</span>         * <a name="line.913"></a>
<span class="sourceLineNo">914</span>         * @see &lt;a href="http://tools.ietf.org/html/rfc1421"&gt;RFC 1421 section<a name="line.914"></a>
<span class="sourceLineNo">915</span>         *      4.3.2.4&lt;/a&gt;<a name="line.915"></a>
<span class="sourceLineNo">916</span>         */<a name="line.916"></a>
<span class="sourceLineNo">917</span>        public static final int PEM_CHUNK_SIZE = 64;<a name="line.917"></a>
<span class="sourceLineNo">918</span><a name="line.918"></a>
<span class="sourceLineNo">919</span>        private static final int DEFAULT_BUFFER_RESIZE_FACTOR = 2;<a name="line.919"></a>
<span class="sourceLineNo">920</span><a name="line.920"></a>
<span class="sourceLineNo">921</span>        /**<a name="line.921"></a>
<span class="sourceLineNo">922</span>         * Defines the default buffer size - currently {@value} - must be large<a name="line.922"></a>
<span class="sourceLineNo">923</span>         * enough for at least one encoded block+separator<a name="line.923"></a>
<span class="sourceLineNo">924</span>         */<a name="line.924"></a>
<span class="sourceLineNo">925</span>        private static final int DEFAULT_BUFFER_SIZE = 8192;<a name="line.925"></a>
<span class="sourceLineNo">926</span><a name="line.926"></a>
<span class="sourceLineNo">927</span>        /** Mask used to extract 8 bits, used in decoding bytes */<a name="line.927"></a>
<span class="sourceLineNo">928</span>        protected static final int MASK_8BITS = 0xff;<a name="line.928"></a>
<span class="sourceLineNo">929</span><a name="line.929"></a>
<span class="sourceLineNo">930</span>        /**<a name="line.930"></a>
<span class="sourceLineNo">931</span>         * Byte used to pad output.<a name="line.931"></a>
<span class="sourceLineNo">932</span>         */<a name="line.932"></a>
<span class="sourceLineNo">933</span>        protected static final byte PAD_DEFAULT = '='; // Allow static access to<a name="line.933"></a>
<span class="sourceLineNo">934</span>                                                                                                        // default<a name="line.934"></a>
<span class="sourceLineNo">935</span><a name="line.935"></a>
<span class="sourceLineNo">936</span>        protected final byte PAD = PAD_DEFAULT; // instance variable just in case it<a name="line.936"></a>
<span class="sourceLineNo">937</span>                                                                                        // needs to vary later<a name="line.937"></a>
<span class="sourceLineNo">938</span><a name="line.938"></a>
<span class="sourceLineNo">939</span>        /**<a name="line.939"></a>
<span class="sourceLineNo">940</span>         * Number of bytes in each full block of unencoded data, e.g. 4 for Base64<a name="line.940"></a>
<span class="sourceLineNo">941</span>         * and 5 for Base32<a name="line.941"></a>
<span class="sourceLineNo">942</span>         */<a name="line.942"></a>
<span class="sourceLineNo">943</span>        private final int unencodedBlockSize;<a name="line.943"></a>
<span class="sourceLineNo">944</span><a name="line.944"></a>
<span class="sourceLineNo">945</span>        /**<a name="line.945"></a>
<span class="sourceLineNo">946</span>         * Number of bytes in each full block of encoded data, e.g. 3 for Base64 and<a name="line.946"></a>
<span class="sourceLineNo">947</span>         * 8 for Base32<a name="line.947"></a>
<span class="sourceLineNo">948</span>         */<a name="line.948"></a>
<span class="sourceLineNo">949</span>        private final int encodedBlockSize;<a name="line.949"></a>
<span class="sourceLineNo">950</span><a name="line.950"></a>
<span class="sourceLineNo">951</span>        /**<a name="line.951"></a>
<span class="sourceLineNo">952</span>         * Chunksize for encoding. Not used when decoding. A value of zero or less<a name="line.952"></a>
<span class="sourceLineNo">953</span>         * implies no chunking of the encoded data. Rounded down to nearest multiple<a name="line.953"></a>
<span class="sourceLineNo">954</span>         * of encodedBlockSize.<a name="line.954"></a>
<span class="sourceLineNo">955</span>         */<a name="line.955"></a>
<span class="sourceLineNo">956</span>        protected int lineLength;<a name="line.956"></a>
<span class="sourceLineNo">957</span><a name="line.957"></a>
<span class="sourceLineNo">958</span>        /**<a name="line.958"></a>
<span class="sourceLineNo">959</span>         * Size of chunk separator. Not used unless {@link #lineLength} &gt; 0.<a name="line.959"></a>
<span class="sourceLineNo">960</span>         */<a name="line.960"></a>
<span class="sourceLineNo">961</span>        private int chunkSeparatorLength;<a name="line.961"></a>
<span class="sourceLineNo">962</span><a name="line.962"></a>
<span class="sourceLineNo">963</span>        /**<a name="line.963"></a>
<span class="sourceLineNo">964</span>         * Note &lt;code&gt;lineLength&lt;/code&gt; is rounded down to the nearest multiple of<a name="line.964"></a>
<span class="sourceLineNo">965</span>         * {@link #encodedBlockSize} If &lt;code&gt;chunkSeparatorLength&lt;/code&gt; is zero,<a name="line.965"></a>
<span class="sourceLineNo">966</span>         * then chunking is disabled.<a name="line.966"></a>
<span class="sourceLineNo">967</span>         * <a name="line.967"></a>
<span class="sourceLineNo">968</span>         * @param unencodedBlockSize<a name="line.968"></a>
<span class="sourceLineNo">969</span>         *            the size of an unencoded block (e.g. Base64 = 3)<a name="line.969"></a>
<span class="sourceLineNo">970</span>         * @param encodedBlockSize<a name="line.970"></a>
<span class="sourceLineNo">971</span>         *            the size of an encoded block (e.g. Base64 = 4)<a name="line.971"></a>
<span class="sourceLineNo">972</span>         * @param lineLength<a name="line.972"></a>
<span class="sourceLineNo">973</span>         *            if &amp;gt; 0, use chunking with a length &lt;code&gt;lineLength&lt;/code&gt;<a name="line.973"></a>
<span class="sourceLineNo">974</span>         * @param chunkSeparatorLength<a name="line.974"></a>
<span class="sourceLineNo">975</span>         *            the chunk separator length, if relevant<a name="line.975"></a>
<span class="sourceLineNo">976</span>         */<a name="line.976"></a>
<span class="sourceLineNo">977</span>        protected Base64(int unencodedBlockSize, int encodedBlockSize, int lineLength, int chunkSeparatorLength) {<a name="line.977"></a>
<span class="sourceLineNo">978</span>                this.unencodedBlockSize = unencodedBlockSize;<a name="line.978"></a>
<span class="sourceLineNo">979</span>                this.encodedBlockSize = encodedBlockSize;<a name="line.979"></a>
<span class="sourceLineNo">980</span>                this.lineLength = (lineLength &gt; 0 &amp;&amp; chunkSeparatorLength &gt; 0) ? (lineLength / encodedBlockSize) * encodedBlockSize : 0;<a name="line.980"></a>
<span class="sourceLineNo">981</span>                this.chunkSeparatorLength = chunkSeparatorLength;<a name="line.981"></a>
<span class="sourceLineNo">982</span>        }<a name="line.982"></a>
<span class="sourceLineNo">983</span><a name="line.983"></a>
<span class="sourceLineNo">984</span>        /**<a name="line.984"></a>
<span class="sourceLineNo">985</span>         * Returns true if this object has buffered data for reading.<a name="line.985"></a>
<span class="sourceLineNo">986</span>         * <a name="line.986"></a>
<span class="sourceLineNo">987</span>         * @param context<a name="line.987"></a>
<span class="sourceLineNo">988</span>         *            the context to be used<a name="line.988"></a>
<span class="sourceLineNo">989</span>         * @return true if there is data still available for reading.<a name="line.989"></a>
<span class="sourceLineNo">990</span>         */<a name="line.990"></a>
<span class="sourceLineNo">991</span>        boolean hasData(Context context) { // package protected for access from I/O<a name="line.991"></a>
<span class="sourceLineNo">992</span>                                                                                // streams<a name="line.992"></a>
<span class="sourceLineNo">993</span>                return context.buffer != null;<a name="line.993"></a>
<span class="sourceLineNo">994</span>        }<a name="line.994"></a>
<span class="sourceLineNo">995</span><a name="line.995"></a>
<span class="sourceLineNo">996</span>        /**<a name="line.996"></a>
<span class="sourceLineNo">997</span>         * Returns the amount of buffered data available for reading.<a name="line.997"></a>
<span class="sourceLineNo">998</span>         * <a name="line.998"></a>
<span class="sourceLineNo">999</span>         * @param context<a name="line.999"></a>
<span class="sourceLineNo">1000</span>         *            the context to be used<a name="line.1000"></a>
<span class="sourceLineNo">1001</span>         * @return The amount of buffered data available for reading.<a name="line.1001"></a>
<span class="sourceLineNo">1002</span>         */<a name="line.1002"></a>
<span class="sourceLineNo">1003</span>        int available(Context context) { // package protected for access from I/O<a name="line.1003"></a>
<span class="sourceLineNo">1004</span>                                                                                // streams<a name="line.1004"></a>
<span class="sourceLineNo">1005</span>                return context.buffer != null ? context.pos - context.readPos : 0;<a name="line.1005"></a>
<span class="sourceLineNo">1006</span>        }<a name="line.1006"></a>
<span class="sourceLineNo">1007</span><a name="line.1007"></a>
<span class="sourceLineNo">1008</span>        /**<a name="line.1008"></a>
<span class="sourceLineNo">1009</span>         * Get the default buffer size. Can be overridden.<a name="line.1009"></a>
<span class="sourceLineNo">1010</span>         * <a name="line.1010"></a>
<span class="sourceLineNo">1011</span>         * @return {@link #DEFAULT_BUFFER_SIZE}<a name="line.1011"></a>
<span class="sourceLineNo">1012</span>         */<a name="line.1012"></a>
<span class="sourceLineNo">1013</span>        protected int getDefaultBufferSize() {<a name="line.1013"></a>
<span class="sourceLineNo">1014</span>                return DEFAULT_BUFFER_SIZE;<a name="line.1014"></a>
<span class="sourceLineNo">1015</span>        }<a name="line.1015"></a>
<span class="sourceLineNo">1016</span><a name="line.1016"></a>
<span class="sourceLineNo">1017</span>        /**<a name="line.1017"></a>
<span class="sourceLineNo">1018</span>         * Increases our buffer by the {@link #DEFAULT_BUFFER_RESIZE_FACTOR}.<a name="line.1018"></a>
<span class="sourceLineNo">1019</span>         * <a name="line.1019"></a>
<span class="sourceLineNo">1020</span>         * @param context<a name="line.1020"></a>
<span class="sourceLineNo">1021</span>         *            the context to be used<a name="line.1021"></a>
<span class="sourceLineNo">1022</span>         */<a name="line.1022"></a>
<span class="sourceLineNo">1023</span>        private void resizeBuffer(Context context) {<a name="line.1023"></a>
<span class="sourceLineNo">1024</span>                if (context.buffer == null) {<a name="line.1024"></a>
<span class="sourceLineNo">1025</span>                        context.buffer = new byte[getDefaultBufferSize()];<a name="line.1025"></a>
<span class="sourceLineNo">1026</span>                        context.pos = 0;<a name="line.1026"></a>
<span class="sourceLineNo">1027</span>                        context.readPos = 0;<a name="line.1027"></a>
<span class="sourceLineNo">1028</span>                } else {<a name="line.1028"></a>
<span class="sourceLineNo">1029</span>                        byte[] b = new byte[context.buffer.length * DEFAULT_BUFFER_RESIZE_FACTOR];<a name="line.1029"></a>
<span class="sourceLineNo">1030</span>                        System.arraycopy(context.buffer, 0, b, 0, context.buffer.length);<a name="line.1030"></a>
<span class="sourceLineNo">1031</span>                        context.buffer = b;<a name="line.1031"></a>
<span class="sourceLineNo">1032</span>                }<a name="line.1032"></a>
<span class="sourceLineNo">1033</span>        }<a name="line.1033"></a>
<span class="sourceLineNo">1034</span><a name="line.1034"></a>
<span class="sourceLineNo">1035</span>        /**<a name="line.1035"></a>
<span class="sourceLineNo">1036</span>         * Ensure that the buffer has room for &lt;code&gt;size&lt;/code&gt; bytes<a name="line.1036"></a>
<span class="sourceLineNo">1037</span>         * <a name="line.1037"></a>
<span class="sourceLineNo">1038</span>         * @param size<a name="line.1038"></a>
<span class="sourceLineNo">1039</span>         *            minimum spare space required<a name="line.1039"></a>
<span class="sourceLineNo">1040</span>         * @param context<a name="line.1040"></a>
<span class="sourceLineNo">1041</span>         *            the context to be used<a name="line.1041"></a>
<span class="sourceLineNo">1042</span>         */<a name="line.1042"></a>
<span class="sourceLineNo">1043</span>        protected void ensureBufferSize(int size, Context context) {<a name="line.1043"></a>
<span class="sourceLineNo">1044</span>                if ((context.buffer == null) || (context.buffer.length &lt; context.pos + size)) {<a name="line.1044"></a>
<span class="sourceLineNo">1045</span>                        resizeBuffer(context);<a name="line.1045"></a>
<span class="sourceLineNo">1046</span>                }<a name="line.1046"></a>
<span class="sourceLineNo">1047</span>        }<a name="line.1047"></a>
<span class="sourceLineNo">1048</span><a name="line.1048"></a>
<span class="sourceLineNo">1049</span>        /**<a name="line.1049"></a>
<span class="sourceLineNo">1050</span>         * Extracts buffered data into the provided byte[] array, starting at<a name="line.1050"></a>
<span class="sourceLineNo">1051</span>         * position bPos, up to a maximum of bAvail bytes. Returns how many bytes<a name="line.1051"></a>
<span class="sourceLineNo">1052</span>         * were actually extracted.<a name="line.1052"></a>
<span class="sourceLineNo">1053</span>         * <a name="line.1053"></a>
<span class="sourceLineNo">1054</span>         * @param b<a name="line.1054"></a>
<span class="sourceLineNo">1055</span>         *            byte[] array to extract the buffered data into.<a name="line.1055"></a>
<span class="sourceLineNo">1056</span>         * @param bPos<a name="line.1056"></a>
<span class="sourceLineNo">1057</span>         *            position in byte[] array to start extraction at.<a name="line.1057"></a>
<span class="sourceLineNo">1058</span>         * @param bAvail<a name="line.1058"></a>
<span class="sourceLineNo">1059</span>         *            amount of bytes we're allowed to extract. We may extract fewer<a name="line.1059"></a>
<span class="sourceLineNo">1060</span>         *            (if fewer are available).<a name="line.1060"></a>
<span class="sourceLineNo">1061</span>         * @param context<a name="line.1061"></a>
<span class="sourceLineNo">1062</span>         *            the context to be used<a name="line.1062"></a>
<span class="sourceLineNo">1063</span>         * @return The number of bytes successfully extracted into the provided<a name="line.1063"></a>
<span class="sourceLineNo">1064</span>         *         byte[] array.<a name="line.1064"></a>
<span class="sourceLineNo">1065</span>         */<a name="line.1065"></a>
<span class="sourceLineNo">1066</span>        int readResults(byte[] b, int bPos, int bAvail, Context context) { // package<a name="line.1066"></a>
<span class="sourceLineNo">1067</span>                                                                                                                                                // protected<a name="line.1067"></a>
<span class="sourceLineNo">1068</span>                                                                                                                                                // for<a name="line.1068"></a>
<span class="sourceLineNo">1069</span>                                                                                                                                                // access<a name="line.1069"></a>
<span class="sourceLineNo">1070</span>                                                                                                                                                // from<a name="line.1070"></a>
<span class="sourceLineNo">1071</span>                                                                                                                                                // I/O<a name="line.1071"></a>
<span class="sourceLineNo">1072</span>                                                                                                                                                // streams<a name="line.1072"></a>
<span class="sourceLineNo">1073</span>                if (context.buffer != null) {<a name="line.1073"></a>
<span class="sourceLineNo">1074</span>                        int len = Math.min(available(context), bAvail);<a name="line.1074"></a>
<span class="sourceLineNo">1075</span>                        System.arraycopy(context.buffer, context.readPos, b, bPos, len);<a name="line.1075"></a>
<span class="sourceLineNo">1076</span>                        context.readPos += len;<a name="line.1076"></a>
<span class="sourceLineNo">1077</span>                        if (context.readPos &gt;= context.pos) {<a name="line.1077"></a>
<span class="sourceLineNo">1078</span>                                context.buffer = null; // so hasData() will return false, and<a name="line.1078"></a>
<span class="sourceLineNo">1079</span>                                                                                // this method can return -1<a name="line.1079"></a>
<span class="sourceLineNo">1080</span>                        }<a name="line.1080"></a>
<span class="sourceLineNo">1081</span>                        return len;<a name="line.1081"></a>
<span class="sourceLineNo">1082</span>                }<a name="line.1082"></a>
<span class="sourceLineNo">1083</span>                return context.eof ? EOF : 0;<a name="line.1083"></a>
<span class="sourceLineNo">1084</span>        }<a name="line.1084"></a>
<span class="sourceLineNo">1085</span><a name="line.1085"></a>
<span class="sourceLineNo">1086</span>        /**<a name="line.1086"></a>
<span class="sourceLineNo">1087</span>         * Checks if a byte value is whitespace or not. Whitespace is taken to mean:<a name="line.1087"></a>
<span class="sourceLineNo">1088</span>         * space, tab, CR, LF<a name="line.1088"></a>
<span class="sourceLineNo">1089</span>         * <a name="line.1089"></a>
<span class="sourceLineNo">1090</span>         * @param byteToCheck<a name="line.1090"></a>
<span class="sourceLineNo">1091</span>         *            the byte to check<a name="line.1091"></a>
<span class="sourceLineNo">1092</span>         * @return true if byte is whitespace, false otherwise<a name="line.1092"></a>
<span class="sourceLineNo">1093</span>         */<a name="line.1093"></a>
<span class="sourceLineNo">1094</span>        protected static boolean isWhiteSpace(byte byteToCheck) {<a name="line.1094"></a>
<span class="sourceLineNo">1095</span>                switch (byteToCheck) {<a name="line.1095"></a>
<span class="sourceLineNo">1096</span>                case ' ':<a name="line.1096"></a>
<span class="sourceLineNo">1097</span>                case '\n':<a name="line.1097"></a>
<span class="sourceLineNo">1098</span>                case '\r':<a name="line.1098"></a>
<span class="sourceLineNo">1099</span>                case '\t':<a name="line.1099"></a>
<span class="sourceLineNo">1100</span>                        return true;<a name="line.1100"></a>
<span class="sourceLineNo">1101</span>                default:<a name="line.1101"></a>
<span class="sourceLineNo">1102</span>                        return false;<a name="line.1102"></a>
<span class="sourceLineNo">1103</span>                }<a name="line.1103"></a>
<span class="sourceLineNo">1104</span>        }<a name="line.1104"></a>
<span class="sourceLineNo">1105</span><a name="line.1105"></a>
<span class="sourceLineNo">1106</span>        /**<a name="line.1106"></a>
<span class="sourceLineNo">1107</span>         * Encodes an Object using the Base-N algorithm. This method is provided in<a name="line.1107"></a>
<span class="sourceLineNo">1108</span>         * order to satisfy the requirements of the Encoder interface, and will<a name="line.1108"></a>
<span class="sourceLineNo">1109</span>         * throw an EncoderException if the supplied object is not of type byte[].<a name="line.1109"></a>
<span class="sourceLineNo">1110</span>         * <a name="line.1110"></a>
<span class="sourceLineNo">1111</span>         * @param obj<a name="line.1111"></a>
<span class="sourceLineNo">1112</span>         *            Object to encode<a name="line.1112"></a>
<span class="sourceLineNo">1113</span>         * @return An object (of type byte[]) containing the Base-N encoded data<a name="line.1113"></a>
<span class="sourceLineNo">1114</span>         *         which corresponds to the byte[] supplied.<a name="line.1114"></a>
<span class="sourceLineNo">1115</span>         * @throws EncoderException<a name="line.1115"></a>
<span class="sourceLineNo">1116</span>         *             if the parameter supplied is not of type byte[]<a name="line.1116"></a>
<span class="sourceLineNo">1117</span>         */<a name="line.1117"></a>
<span class="sourceLineNo">1118</span>        public Object encode(Object obj) throws Exception {<a name="line.1118"></a>
<span class="sourceLineNo">1119</span>                if (!(obj instanceof byte[])) {<a name="line.1119"></a>
<span class="sourceLineNo">1120</span>                        throw new Exception("Parameter supplied to Base-N encode is not a byte[]");<a name="line.1120"></a>
<span class="sourceLineNo">1121</span>                }<a name="line.1121"></a>
<span class="sourceLineNo">1122</span>                return encode((byte[]) obj);<a name="line.1122"></a>
<span class="sourceLineNo">1123</span>        }<a name="line.1123"></a>
<span class="sourceLineNo">1124</span><a name="line.1124"></a>
<span class="sourceLineNo">1125</span>        /**<a name="line.1125"></a>
<span class="sourceLineNo">1126</span>         * Encodes a byte[] containing binary data, into a String containing<a name="line.1126"></a>
<span class="sourceLineNo">1127</span>         * characters in the Base-N alphabet. Uses UTF8 encoding.<a name="line.1127"></a>
<span class="sourceLineNo">1128</span>         * <a name="line.1128"></a>
<span class="sourceLineNo">1129</span>         * @param pArray<a name="line.1129"></a>
<span class="sourceLineNo">1130</span>         *            a byte array containing binary data<a name="line.1130"></a>
<span class="sourceLineNo">1131</span>         * @return A String containing only Base-N character data<a name="line.1131"></a>
<span class="sourceLineNo">1132</span>         */<a name="line.1132"></a>
<span class="sourceLineNo">1133</span>        public String encodeToString(byte[] pArray) {<a name="line.1133"></a>
<span class="sourceLineNo">1134</span>                return StringUtils.newStringUtf8(encode(pArray));<a name="line.1134"></a>
<span class="sourceLineNo">1135</span>        }<a name="line.1135"></a>
<span class="sourceLineNo">1136</span><a name="line.1136"></a>
<span class="sourceLineNo">1137</span>        /**<a name="line.1137"></a>
<span class="sourceLineNo">1138</span>         * Encodes a byte[] containing binary data, into a String containing<a name="line.1138"></a>
<span class="sourceLineNo">1139</span>         * characters in the appropriate alphabet. Uses UTF8 encoding.<a name="line.1139"></a>
<span class="sourceLineNo">1140</span>         * <a name="line.1140"></a>
<span class="sourceLineNo">1141</span>         * @param pArray<a name="line.1141"></a>
<span class="sourceLineNo">1142</span>         *            a byte array containing binary data<a name="line.1142"></a>
<span class="sourceLineNo">1143</span>         * @return String containing only character data in the appropriate<a name="line.1143"></a>
<span class="sourceLineNo">1144</span>         *         alphabet.<a name="line.1144"></a>
<span class="sourceLineNo">1145</span>         */<a name="line.1145"></a>
<span class="sourceLineNo">1146</span>        public String encodeAsString(byte[] pArray) {<a name="line.1146"></a>
<span class="sourceLineNo">1147</span>                return StringUtils.newStringUtf8(encode(pArray));<a name="line.1147"></a>
<span class="sourceLineNo">1148</span>        }<a name="line.1148"></a>
<span class="sourceLineNo">1149</span><a name="line.1149"></a>
<span class="sourceLineNo">1150</span>        /**<a name="line.1150"></a>
<span class="sourceLineNo">1151</span>         * Decodes an Object using the Base-N algorithm. This method is provided in<a name="line.1151"></a>
<span class="sourceLineNo">1152</span>         * order to satisfy the requirements of the Decoder interface, and will<a name="line.1152"></a>
<span class="sourceLineNo">1153</span>         * throw a DecoderException if the supplied object is not of type byte[] or<a name="line.1153"></a>
<span class="sourceLineNo">1154</span>         * String.<a name="line.1154"></a>
<span class="sourceLineNo">1155</span>         * <a name="line.1155"></a>
<span class="sourceLineNo">1156</span>         * @param obj<a name="line.1156"></a>
<span class="sourceLineNo">1157</span>         *            Object to decode<a name="line.1157"></a>
<span class="sourceLineNo">1158</span>         * @return An object (of type byte[]) containing the binary data which<a name="line.1158"></a>
<span class="sourceLineNo">1159</span>         *         corresponds to the byte[] or String supplied.<a name="line.1159"></a>
<span class="sourceLineNo">1160</span>         * @throws DecoderException<a name="line.1160"></a>
<span class="sourceLineNo">1161</span>         *             if the parameter supplied is not of type byte[]<a name="line.1161"></a>
<span class="sourceLineNo">1162</span>         */<a name="line.1162"></a>
<span class="sourceLineNo">1163</span>        public Object decode(Object obj) throws Exception {<a name="line.1163"></a>
<span class="sourceLineNo">1164</span>                if (obj instanceof byte[]) {<a name="line.1164"></a>
<span class="sourceLineNo">1165</span>                        return decode((byte[]) obj);<a name="line.1165"></a>
<span class="sourceLineNo">1166</span>                } else if (obj instanceof String) {<a name="line.1166"></a>
<span class="sourceLineNo">1167</span>                        return decode((String) obj);<a name="line.1167"></a>
<span class="sourceLineNo">1168</span>                } else {<a name="line.1168"></a>
<span class="sourceLineNo">1169</span>                        throw new Exception("Parameter supplied to Base-N decode is not a byte[] or a String");<a name="line.1169"></a>
<span class="sourceLineNo">1170</span>                }<a name="line.1170"></a>
<span class="sourceLineNo">1171</span>        }<a name="line.1171"></a>
<span class="sourceLineNo">1172</span><a name="line.1172"></a>
<span class="sourceLineNo">1173</span>        /**<a name="line.1173"></a>
<span class="sourceLineNo">1174</span>         * Decodes a String containing characters in the Base-N alphabet.<a name="line.1174"></a>
<span class="sourceLineNo">1175</span>         * <a name="line.1175"></a>
<span class="sourceLineNo">1176</span>         * @param pArray<a name="line.1176"></a>
<span class="sourceLineNo">1177</span>         *            A String containing Base-N character data<a name="line.1177"></a>
<span class="sourceLineNo">1178</span>         * @return a byte array containing binary data<a name="line.1178"></a>
<span class="sourceLineNo">1179</span>         */<a name="line.1179"></a>
<span class="sourceLineNo">1180</span>        public byte[] decode(String pArray) {<a name="line.1180"></a>
<span class="sourceLineNo">1181</span>                return decode(StringUtils.getBytesUtf8(pArray));<a name="line.1181"></a>
<span class="sourceLineNo">1182</span>        }<a name="line.1182"></a>
<span class="sourceLineNo">1183</span><a name="line.1183"></a>
<span class="sourceLineNo">1184</span>        /**<a name="line.1184"></a>
<span class="sourceLineNo">1185</span>         * Decodes a byte[] containing characters in the Base-N alphabet.<a name="line.1185"></a>
<span class="sourceLineNo">1186</span>         * <a name="line.1186"></a>
<span class="sourceLineNo">1187</span>         * @param pArray<a name="line.1187"></a>
<span class="sourceLineNo">1188</span>         *            A byte array containing Base-N character data<a name="line.1188"></a>
<span class="sourceLineNo">1189</span>         * @return a byte array containing binary data<a name="line.1189"></a>
<span class="sourceLineNo">1190</span>         */<a name="line.1190"></a>
<span class="sourceLineNo">1191</span>        public byte[] decode(byte[] pArray) {<a name="line.1191"></a>
<span class="sourceLineNo">1192</span>                Context context = new Context();<a name="line.1192"></a>
<span class="sourceLineNo">1193</span>                if (pArray == null || pArray.length == 0) {<a name="line.1193"></a>
<span class="sourceLineNo">1194</span>                        return pArray;<a name="line.1194"></a>
<span class="sourceLineNo">1195</span>                }<a name="line.1195"></a>
<span class="sourceLineNo">1196</span>                decode(pArray, 0, pArray.length, context);<a name="line.1196"></a>
<span class="sourceLineNo">1197</span>                decode(pArray, 0, EOF, context); // Notify decoder of EOF.<a name="line.1197"></a>
<span class="sourceLineNo">1198</span>                byte[] result = new byte[context.pos];<a name="line.1198"></a>
<span class="sourceLineNo">1199</span>                readResults(result, 0, result.length, context);<a name="line.1199"></a>
<span class="sourceLineNo">1200</span>                return result;<a name="line.1200"></a>
<span class="sourceLineNo">1201</span>        }<a name="line.1201"></a>
<span class="sourceLineNo">1202</span><a name="line.1202"></a>
<span class="sourceLineNo">1203</span>        /**<a name="line.1203"></a>
<span class="sourceLineNo">1204</span>         * Encodes a byte[] containing binary data, into a byte[] containing<a name="line.1204"></a>
<span class="sourceLineNo">1205</span>         * characters in the alphabet.<a name="line.1205"></a>
<span class="sourceLineNo">1206</span>         * <a name="line.1206"></a>
<span class="sourceLineNo">1207</span>         * @param pArray<a name="line.1207"></a>
<span class="sourceLineNo">1208</span>         *            a byte array containing binary data<a name="line.1208"></a>
<span class="sourceLineNo">1209</span>         * @return A byte array containing only the basen alphabetic character data<a name="line.1209"></a>
<span class="sourceLineNo">1210</span>         */<a name="line.1210"></a>
<span class="sourceLineNo">1211</span>        public byte[] encode(byte[] pArray) {<a name="line.1211"></a>
<span class="sourceLineNo">1212</span>                Context context = new Context();<a name="line.1212"></a>
<span class="sourceLineNo">1213</span>                if (pArray == null || pArray.length == 0) {<a name="line.1213"></a>
<span class="sourceLineNo">1214</span>                        return pArray;<a name="line.1214"></a>
<span class="sourceLineNo">1215</span>                }<a name="line.1215"></a>
<span class="sourceLineNo">1216</span>                encode(pArray, 0, pArray.length, context);<a name="line.1216"></a>
<span class="sourceLineNo">1217</span>                encode(pArray, 0, EOF, context); // Notify encoder of EOF.<a name="line.1217"></a>
<span class="sourceLineNo">1218</span>                byte[] buf = new byte[context.pos - context.readPos];<a name="line.1218"></a>
<span class="sourceLineNo">1219</span>                readResults(buf, 0, buf.length, context);<a name="line.1219"></a>
<span class="sourceLineNo">1220</span>                return buf;<a name="line.1220"></a>
<span class="sourceLineNo">1221</span>        }<a name="line.1221"></a>
<span class="sourceLineNo">1222</span><a name="line.1222"></a>
<span class="sourceLineNo">1223</span>        /**<a name="line.1223"></a>
<span class="sourceLineNo">1224</span>         * Tests a given byte array to see if it contains only valid characters<a name="line.1224"></a>
<span class="sourceLineNo">1225</span>         * within the alphabet. The method optionally treats whitespace and pad as<a name="line.1225"></a>
<span class="sourceLineNo">1226</span>         * valid.<a name="line.1226"></a>
<span class="sourceLineNo">1227</span>         * <a name="line.1227"></a>
<span class="sourceLineNo">1228</span>         * @param arrayOctet<a name="line.1228"></a>
<span class="sourceLineNo">1229</span>         *            byte array to test<a name="line.1229"></a>
<span class="sourceLineNo">1230</span>         * @param allowWSPad<a name="line.1230"></a>
<span class="sourceLineNo">1231</span>         *            if {@code true}, then whitespace and PAD are also allowed<a name="line.1231"></a>
<span class="sourceLineNo">1232</span>         * <a name="line.1232"></a>
<span class="sourceLineNo">1233</span>         * @return {@code true} if all bytes are valid characters in the alphabet or<a name="line.1233"></a>
<span class="sourceLineNo">1234</span>         *         if the byte array is empty; {@code false}, otherwise<a name="line.1234"></a>
<span class="sourceLineNo">1235</span>         */<a name="line.1235"></a>
<span class="sourceLineNo">1236</span>        public boolean isInAlphabet(byte[] arrayOctet, boolean allowWSPad) {<a name="line.1236"></a>
<span class="sourceLineNo">1237</span>                for (int i = 0; i &lt; arrayOctet.length; i++) {<a name="line.1237"></a>
<span class="sourceLineNo">1238</span>                        if (!isInAlphabet(arrayOctet[i]) &amp;&amp; (!allowWSPad || (arrayOctet[i] != PAD) &amp;&amp; !isWhiteSpace(arrayOctet[i]))) {<a name="line.1238"></a>
<span class="sourceLineNo">1239</span>                                return false;<a name="line.1239"></a>
<span class="sourceLineNo">1240</span>                        }<a name="line.1240"></a>
<span class="sourceLineNo">1241</span>                }<a name="line.1241"></a>
<span class="sourceLineNo">1242</span>                return true;<a name="line.1242"></a>
<span class="sourceLineNo">1243</span>        }<a name="line.1243"></a>
<span class="sourceLineNo">1244</span><a name="line.1244"></a>
<span class="sourceLineNo">1245</span>        /**<a name="line.1245"></a>
<span class="sourceLineNo">1246</span>         * Tests a given String to see if it contains only valid characters within<a name="line.1246"></a>
<span class="sourceLineNo">1247</span>         * the alphabet. The method treats whitespace and PAD as valid.<a name="line.1247"></a>
<span class="sourceLineNo">1248</span>         * <a name="line.1248"></a>
<span class="sourceLineNo">1249</span>         * @param basen<a name="line.1249"></a>
<span class="sourceLineNo">1250</span>         *            String to test<a name="line.1250"></a>
<span class="sourceLineNo">1251</span>         * @return {@code true} if all characters in the String are valid characters<a name="line.1251"></a>
<span class="sourceLineNo">1252</span>         *         in the alphabet or if the String is empty; {@code false},<a name="line.1252"></a>
<span class="sourceLineNo">1253</span>         *         otherwise<a name="line.1253"></a>
<span class="sourceLineNo">1254</span>         * @see #isInAlphabet(byte[], boolean)<a name="line.1254"></a>
<span class="sourceLineNo">1255</span>         */<a name="line.1255"></a>
<span class="sourceLineNo">1256</span>        public boolean isInAlphabet(String basen) {<a name="line.1256"></a>
<span class="sourceLineNo">1257</span>                return isInAlphabet(StringUtils.getBytesUtf8(basen), true);<a name="line.1257"></a>
<span class="sourceLineNo">1258</span>        }<a name="line.1258"></a>
<span class="sourceLineNo">1259</span><a name="line.1259"></a>
<span class="sourceLineNo">1260</span>        /**<a name="line.1260"></a>
<span class="sourceLineNo">1261</span>         * Tests a given byte array to see if it contains any characters within the<a name="line.1261"></a>
<span class="sourceLineNo">1262</span>         * alphabet or PAD.<a name="line.1262"></a>
<span class="sourceLineNo">1263</span>         * <a name="line.1263"></a>
<span class="sourceLineNo">1264</span>         * Intended for use in checking line-ending arrays<a name="line.1264"></a>
<span class="sourceLineNo">1265</span>         * <a name="line.1265"></a>
<span class="sourceLineNo">1266</span>         * @param arrayOctet<a name="line.1266"></a>
<span class="sourceLineNo">1267</span>         *            byte array to test<a name="line.1267"></a>
<span class="sourceLineNo">1268</span>         * @return {@code true} if any byte is a valid character in the alphabet or<a name="line.1268"></a>
<span class="sourceLineNo">1269</span>         *         PAD; {@code false} otherwise<a name="line.1269"></a>
<span class="sourceLineNo">1270</span>         */<a name="line.1270"></a>
<span class="sourceLineNo">1271</span>        protected boolean containsAlphabetOrPad(byte[] arrayOctet) {<a name="line.1271"></a>
<span class="sourceLineNo">1272</span>                if (arrayOctet == null) {<a name="line.1272"></a>
<span class="sourceLineNo">1273</span>                        return false;<a name="line.1273"></a>
<span class="sourceLineNo">1274</span>                }<a name="line.1274"></a>
<span class="sourceLineNo">1275</span>                for (byte element : arrayOctet) {<a name="line.1275"></a>
<span class="sourceLineNo">1276</span>                        if (PAD == element || isInAlphabet(element)) {<a name="line.1276"></a>
<span class="sourceLineNo">1277</span>                                return true;<a name="line.1277"></a>
<span class="sourceLineNo">1278</span>                        }<a name="line.1278"></a>
<span class="sourceLineNo">1279</span>                }<a name="line.1279"></a>
<span class="sourceLineNo">1280</span>                return false;<a name="line.1280"></a>
<span class="sourceLineNo">1281</span>        }<a name="line.1281"></a>
<span class="sourceLineNo">1282</span><a name="line.1282"></a>
<span class="sourceLineNo">1283</span>        /**<a name="line.1283"></a>
<span class="sourceLineNo">1284</span>         * Calculates the amount of space needed to encode the supplied array.<a name="line.1284"></a>
<span class="sourceLineNo">1285</span>         * <a name="line.1285"></a>
<span class="sourceLineNo">1286</span>         * @param pArray<a name="line.1286"></a>
<span class="sourceLineNo">1287</span>         *            byte[] array which will later be encoded<a name="line.1287"></a>
<span class="sourceLineNo">1288</span>         * <a name="line.1288"></a>
<span class="sourceLineNo">1289</span>         * @return amount of space needed to encoded the supplied array. Returns a<a name="line.1289"></a>
<span class="sourceLineNo">1290</span>         *         long since a max-len array will require &gt; Integer.MAX_VALUE<a name="line.1290"></a>
<span class="sourceLineNo">1291</span>         */<a name="line.1291"></a>
<span class="sourceLineNo">1292</span>        public long getEncodedLength(byte[] pArray) {<a name="line.1292"></a>
<span class="sourceLineNo">1293</span>                // Calculate non-chunked size - rounded up to allow for padding<a name="line.1293"></a>
<span class="sourceLineNo">1294</span>                // cast to long is needed to avoid possibility of overflow<a name="line.1294"></a>
<span class="sourceLineNo">1295</span>                long len = ((pArray.length + unencodedBlockSize - 1) / unencodedBlockSize) * (long) encodedBlockSize;<a name="line.1295"></a>
<span class="sourceLineNo">1296</span>                if (lineLength &gt; 0) { // We're using chunking<a name="line.1296"></a>
<span class="sourceLineNo">1297</span>                        // Round up to nearest multiple<a name="line.1297"></a>
<span class="sourceLineNo">1298</span>                        len += ((len + lineLength - 1) / lineLength) * chunkSeparatorLength;<a name="line.1298"></a>
<span class="sourceLineNo">1299</span>                }<a name="line.1299"></a>
<span class="sourceLineNo">1300</span>                return len;<a name="line.1300"></a>
<span class="sourceLineNo">1301</span>        }<a name="line.1301"></a>
<span class="sourceLineNo">1302</span><a name="line.1302"></a>
<span class="sourceLineNo">1303</span>        /**<a name="line.1303"></a>
<span class="sourceLineNo">1304</span>         * Character encoding names required of every implementation of the Java<a name="line.1304"></a>
<span class="sourceLineNo">1305</span>         * platform.<a name="line.1305"></a>
<span class="sourceLineNo">1306</span>         * <a name="line.1306"></a>
<span class="sourceLineNo">1307</span>         * From the Java documentation &lt;a href=<a name="line.1307"></a>
<span class="sourceLineNo">1308</span>         * "http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"<a name="line.1308"></a>
<span class="sourceLineNo">1309</span>         * &gt;Standard charsets&lt;/a&gt;:<a name="line.1309"></a>
<span class="sourceLineNo">1310</span>         * &lt;p&gt;<a name="line.1310"></a>
<span class="sourceLineNo">1311</span>         * &lt;cite&gt;Every implementation of the Java platform is required to support<a name="line.1311"></a>
<span class="sourceLineNo">1312</span>         * the following character encodings. Consult the release documentation for<a name="line.1312"></a>
<span class="sourceLineNo">1313</span>         * your implementation to see if any other encodings are supported. Consult<a name="line.1313"></a>
<span class="sourceLineNo">1314</span>         * the release documentation for your implementation to see if any other<a name="line.1314"></a>
<span class="sourceLineNo">1315</span>         * encodings are supported. &lt;/cite&gt;<a name="line.1315"></a>
<span class="sourceLineNo">1316</span>         * &lt;/p&gt;<a name="line.1316"></a>
<span class="sourceLineNo">1317</span>         * <a name="line.1317"></a>
<span class="sourceLineNo">1318</span>         * &lt;ul&gt;<a name="line.1318"></a>
<span class="sourceLineNo">1319</span>         * &lt;li&gt;&lt;code&gt;US-ASCII&lt;/code&gt;&lt;br/&gt;<a name="line.1319"></a>
<span class="sourceLineNo">1320</span>         * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the<a name="line.1320"></a>
<span class="sourceLineNo">1321</span>         * Unicode character set.&lt;/li&gt;<a name="line.1321"></a>
<span class="sourceLineNo">1322</span>         * &lt;li&gt;&lt;code&gt;ISO-8859-1&lt;/code&gt;&lt;br/&gt;<a name="line.1322"></a>
<span class="sourceLineNo">1323</span>         * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.&lt;/li&gt;<a name="line.1323"></a>
<span class="sourceLineNo">1324</span>         * &lt;li&gt;&lt;code&gt;UTF-8&lt;/code&gt;&lt;br/&gt;<a name="line.1324"></a>
<span class="sourceLineNo">1325</span>         * Eight-bit Unicode Transformation Format.&lt;/li&gt;<a name="line.1325"></a>
<span class="sourceLineNo">1326</span>         * &lt;li&gt;&lt;code&gt;UTF-16BE&lt;/code&gt;&lt;br/&gt;<a name="line.1326"></a>
<span class="sourceLineNo">1327</span>         * Sixteen-bit Unicode Transformation Format, big-endian byte order.&lt;/li&gt;<a name="line.1327"></a>
<span class="sourceLineNo">1328</span>         * &lt;li&gt;&lt;code&gt;UTF-16LE&lt;/code&gt;&lt;br/&gt;<a name="line.1328"></a>
<span class="sourceLineNo">1329</span>         * Sixteen-bit Unicode Transformation Format, little-endian byte order.&lt;/li&gt;<a name="line.1329"></a>
<span class="sourceLineNo">1330</span>         * &lt;li&gt;&lt;code&gt;UTF-16&lt;/code&gt;&lt;br/&gt;<a name="line.1330"></a>
<span class="sourceLineNo">1331</span>         * Sixteen-bit Unicode Transformation Format, byte order specified by a<a name="line.1331"></a>
<span class="sourceLineNo">1332</span>         * mandatory initial byte-order mark (either order accepted on input,<a name="line.1332"></a>
<span class="sourceLineNo">1333</span>         * big-endian used on output.)&lt;/li&gt;<a name="line.1333"></a>
<span class="sourceLineNo">1334</span>         * &lt;/ul&gt;<a name="line.1334"></a>
<span class="sourceLineNo">1335</span>         * <a name="line.1335"></a>
<span class="sourceLineNo">1336</span>         * This perhaps would best belong in the [lang] project. Even if a similar<a name="line.1336"></a>
<span class="sourceLineNo">1337</span>         * interface is defined in [lang], it is not foreseen that [codec] would be<a name="line.1337"></a>
<span class="sourceLineNo">1338</span>         * made to depend on [lang].<a name="line.1338"></a>
<span class="sourceLineNo">1339</span>         * <a name="line.1339"></a>
<span class="sourceLineNo">1340</span>         * &lt;p&gt;<a name="line.1340"></a>
<span class="sourceLineNo">1341</span>         * This class is immutable and thread-safe.<a name="line.1341"></a>
<span class="sourceLineNo">1342</span>         * &lt;/p&gt;<a name="line.1342"></a>
<span class="sourceLineNo">1343</span>         * <a name="line.1343"></a>
<span class="sourceLineNo">1344</span>         * @see &lt;a<a name="line.1344"></a>
<span class="sourceLineNo">1345</span>         *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1345"></a>
<span class="sourceLineNo">1346</span>         *      charsets&lt;/a&gt;<a name="line.1346"></a>
<span class="sourceLineNo">1347</span>         * @since 1.4<a name="line.1347"></a>
<span class="sourceLineNo">1348</span>         * @version $Id$<a name="line.1348"></a>
<span class="sourceLineNo">1349</span>         */<a name="line.1349"></a>
<span class="sourceLineNo">1350</span>        public class CharEncoding {<a name="line.1350"></a>
<span class="sourceLineNo">1351</span>                /**<a name="line.1351"></a>
<span class="sourceLineNo">1352</span>                 * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. &lt;/p&gt;<a name="line.1352"></a>
<span class="sourceLineNo">1353</span>                 * &lt;p&gt;<a name="line.1353"></a>
<span class="sourceLineNo">1354</span>                 * Every implementation of the Java platform is required to support this<a name="line.1354"></a>
<span class="sourceLineNo">1355</span>                 * character encoding.<a name="line.1355"></a>
<span class="sourceLineNo">1356</span>                 * &lt;/p&gt;<a name="line.1356"></a>
<span class="sourceLineNo">1357</span>                 * <a name="line.1357"></a>
<span class="sourceLineNo">1358</span>                 * @see &lt;a<a name="line.1358"></a>
<span class="sourceLineNo">1359</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1359"></a>
<span class="sourceLineNo">1360</span>                 *      charsets&lt;/a&gt;<a name="line.1360"></a>
<span class="sourceLineNo">1361</span>                 */<a name="line.1361"></a>
<span class="sourceLineNo">1362</span>                public static final String ISO_8859_1 = "ISO-8859-1";<a name="line.1362"></a>
<span class="sourceLineNo">1363</span><a name="line.1363"></a>
<span class="sourceLineNo">1364</span>                /**<a name="line.1364"></a>
<span class="sourceLineNo">1365</span>                 * &lt;p&gt;<a name="line.1365"></a>
<span class="sourceLineNo">1366</span>                 * Seven-bit ASCII, also known as ISO646-US, also known as the Basic<a name="line.1366"></a>
<span class="sourceLineNo">1367</span>                 * Latin block of the Unicode character set.<a name="line.1367"></a>
<span class="sourceLineNo">1368</span>                 * &lt;/p&gt;<a name="line.1368"></a>
<span class="sourceLineNo">1369</span>                 * &lt;p&gt;<a name="line.1369"></a>
<span class="sourceLineNo">1370</span>                 * Every implementation of the Java platform is required to support this<a name="line.1370"></a>
<span class="sourceLineNo">1371</span>                 * character encoding.<a name="line.1371"></a>
<span class="sourceLineNo">1372</span>                 * &lt;/p&gt;<a name="line.1372"></a>
<span class="sourceLineNo">1373</span>                 * <a name="line.1373"></a>
<span class="sourceLineNo">1374</span>                 * @see &lt;a<a name="line.1374"></a>
<span class="sourceLineNo">1375</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1375"></a>
<span class="sourceLineNo">1376</span>                 *      charsets&lt;/a&gt;<a name="line.1376"></a>
<span class="sourceLineNo">1377</span>                 */<a name="line.1377"></a>
<span class="sourceLineNo">1378</span>                public static final String US_ASCII = "US-ASCII";<a name="line.1378"></a>
<span class="sourceLineNo">1379</span><a name="line.1379"></a>
<span class="sourceLineNo">1380</span>                /**<a name="line.1380"></a>
<span class="sourceLineNo">1381</span>                 * &lt;p&gt;<a name="line.1381"></a>
<span class="sourceLineNo">1382</span>                 * Sixteen-bit Unicode Transformation Format, The byte order specified<a name="line.1382"></a>
<span class="sourceLineNo">1383</span>                 * by a mandatory initial byte-order mark (either order accepted on<a name="line.1383"></a>
<span class="sourceLineNo">1384</span>                 * input, big-endian used on output)<a name="line.1384"></a>
<span class="sourceLineNo">1385</span>                 * &lt;/p&gt;<a name="line.1385"></a>
<span class="sourceLineNo">1386</span>                 * &lt;p&gt;<a name="line.1386"></a>
<span class="sourceLineNo">1387</span>                 * Every implementation of the Java platform is required to support this<a name="line.1387"></a>
<span class="sourceLineNo">1388</span>                 * character encoding.<a name="line.1388"></a>
<span class="sourceLineNo">1389</span>                 * &lt;/p&gt;<a name="line.1389"></a>
<span class="sourceLineNo">1390</span>                 * <a name="line.1390"></a>
<span class="sourceLineNo">1391</span>                 * @see &lt;a<a name="line.1391"></a>
<span class="sourceLineNo">1392</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1392"></a>
<span class="sourceLineNo">1393</span>                 *      charsets&lt;/a&gt;<a name="line.1393"></a>
<span class="sourceLineNo">1394</span>                 */<a name="line.1394"></a>
<span class="sourceLineNo">1395</span>                public static final String UTF_16 = "UTF-16";<a name="line.1395"></a>
<span class="sourceLineNo">1396</span><a name="line.1396"></a>
<span class="sourceLineNo">1397</span>                /**<a name="line.1397"></a>
<span class="sourceLineNo">1398</span>                 * &lt;p&gt;<a name="line.1398"></a>
<span class="sourceLineNo">1399</span>                 * Sixteen-bit Unicode Transformation Format, big-endian byte order.<a name="line.1399"></a>
<span class="sourceLineNo">1400</span>                 * &lt;/p&gt;<a name="line.1400"></a>
<span class="sourceLineNo">1401</span>                 * &lt;p&gt;<a name="line.1401"></a>
<span class="sourceLineNo">1402</span>                 * Every implementation of the Java platform is required to support this<a name="line.1402"></a>
<span class="sourceLineNo">1403</span>                 * character encoding.<a name="line.1403"></a>
<span class="sourceLineNo">1404</span>                 * &lt;/p&gt;<a name="line.1404"></a>
<span class="sourceLineNo">1405</span>                 * <a name="line.1405"></a>
<span class="sourceLineNo">1406</span>                 * @see &lt;a<a name="line.1406"></a>
<span class="sourceLineNo">1407</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1407"></a>
<span class="sourceLineNo">1408</span>                 *      charsets&lt;/a&gt;<a name="line.1408"></a>
<span class="sourceLineNo">1409</span>                 */<a name="line.1409"></a>
<span class="sourceLineNo">1410</span>                public static final String UTF_16BE = "UTF-16BE";<a name="line.1410"></a>
<span class="sourceLineNo">1411</span><a name="line.1411"></a>
<span class="sourceLineNo">1412</span>                /**<a name="line.1412"></a>
<span class="sourceLineNo">1413</span>                 * &lt;p&gt;<a name="line.1413"></a>
<span class="sourceLineNo">1414</span>                 * Sixteen-bit Unicode Transformation Format, little-endian byte order.<a name="line.1414"></a>
<span class="sourceLineNo">1415</span>                 * &lt;/p&gt;<a name="line.1415"></a>
<span class="sourceLineNo">1416</span>                 * &lt;p&gt;<a name="line.1416"></a>
<span class="sourceLineNo">1417</span>                 * Every implementation of the Java platform is required to support this<a name="line.1417"></a>
<span class="sourceLineNo">1418</span>                 * character encoding.<a name="line.1418"></a>
<span class="sourceLineNo">1419</span>                 * &lt;/p&gt;<a name="line.1419"></a>
<span class="sourceLineNo">1420</span>                 * <a name="line.1420"></a>
<span class="sourceLineNo">1421</span>                 * @see &lt;a<a name="line.1421"></a>
<span class="sourceLineNo">1422</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1422"></a>
<span class="sourceLineNo">1423</span>                 *      charsets&lt;/a&gt;<a name="line.1423"></a>
<span class="sourceLineNo">1424</span>                 */<a name="line.1424"></a>
<span class="sourceLineNo">1425</span>                public static final String UTF_16LE = "UTF-16LE";<a name="line.1425"></a>
<span class="sourceLineNo">1426</span><a name="line.1426"></a>
<span class="sourceLineNo">1427</span>                /**<a name="line.1427"></a>
<span class="sourceLineNo">1428</span>                 * &lt;p&gt;<a name="line.1428"></a>
<span class="sourceLineNo">1429</span>                 * Eight-bit Unicode Transformation Format.<a name="line.1429"></a>
<span class="sourceLineNo">1430</span>                 * &lt;/p&gt;<a name="line.1430"></a>
<span class="sourceLineNo">1431</span>                 * &lt;p&gt;<a name="line.1431"></a>
<span class="sourceLineNo">1432</span>                 * Every implementation of the Java platform is required to support this<a name="line.1432"></a>
<span class="sourceLineNo">1433</span>                 * character encoding.<a name="line.1433"></a>
<span class="sourceLineNo">1434</span>                 * &lt;/p&gt;<a name="line.1434"></a>
<span class="sourceLineNo">1435</span>                 * <a name="line.1435"></a>
<span class="sourceLineNo">1436</span>                 * @see &lt;a<a name="line.1436"></a>
<span class="sourceLineNo">1437</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1437"></a>
<span class="sourceLineNo">1438</span>                 *      charsets&lt;/a&gt;<a name="line.1438"></a>
<span class="sourceLineNo">1439</span>                 */<a name="line.1439"></a>
<span class="sourceLineNo">1440</span>                public static final String UTF_8 = "UTF-8";<a name="line.1440"></a>
<span class="sourceLineNo">1441</span>        }<a name="line.1441"></a>
<span class="sourceLineNo">1442</span><a name="line.1442"></a>
<span class="sourceLineNo">1443</span>        /**<a name="line.1443"></a>
<span class="sourceLineNo">1444</span>         * Charsets required of every implementation of the Java platform.<a name="line.1444"></a>
<span class="sourceLineNo">1445</span>         * <a name="line.1445"></a>
<span class="sourceLineNo">1446</span>         * From the Java documentation &lt;a href=<a name="line.1446"></a>
<span class="sourceLineNo">1447</span>         * "http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"<a name="line.1447"></a>
<span class="sourceLineNo">1448</span>         * &gt;Standard charsets&lt;/a&gt;:<a name="line.1448"></a>
<span class="sourceLineNo">1449</span>         * &lt;p&gt;<a name="line.1449"></a>
<span class="sourceLineNo">1450</span>         * &lt;cite&gt;Every implementation of the Java platform is required to support<a name="line.1450"></a>
<span class="sourceLineNo">1451</span>         * the following character encodings. Consult the release documentation for<a name="line.1451"></a>
<span class="sourceLineNo">1452</span>         * your implementation to see if any other encodings are supported. Consult<a name="line.1452"></a>
<span class="sourceLineNo">1453</span>         * the release documentation for your implementation to see if any other<a name="line.1453"></a>
<span class="sourceLineNo">1454</span>         * encodings are supported. &lt;/cite&gt;<a name="line.1454"></a>
<span class="sourceLineNo">1455</span>         * &lt;/p&gt;<a name="line.1455"></a>
<span class="sourceLineNo">1456</span>         * <a name="line.1456"></a>
<span class="sourceLineNo">1457</span>         * &lt;ul&gt;<a name="line.1457"></a>
<span class="sourceLineNo">1458</span>         * &lt;li&gt;&lt;code&gt;US-ASCII&lt;/code&gt;&lt;br/&gt;<a name="line.1458"></a>
<span class="sourceLineNo">1459</span>         * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the<a name="line.1459"></a>
<span class="sourceLineNo">1460</span>         * Unicode character set.&lt;/li&gt;<a name="line.1460"></a>
<span class="sourceLineNo">1461</span>         * &lt;li&gt;&lt;code&gt;ISO-8859-1&lt;/code&gt;&lt;br/&gt;<a name="line.1461"></a>
<span class="sourceLineNo">1462</span>         * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.&lt;/li&gt;<a name="line.1462"></a>
<span class="sourceLineNo">1463</span>         * &lt;li&gt;&lt;code&gt;UTF-8&lt;/code&gt;&lt;br/&gt;<a name="line.1463"></a>
<span class="sourceLineNo">1464</span>         * Eight-bit Unicode Transformation Format.&lt;/li&gt;<a name="line.1464"></a>
<span class="sourceLineNo">1465</span>         * &lt;li&gt;&lt;code&gt;UTF-16BE&lt;/code&gt;&lt;br/&gt;<a name="line.1465"></a>
<span class="sourceLineNo">1466</span>         * Sixteen-bit Unicode Transformation Format, big-endian byte order.&lt;/li&gt;<a name="line.1466"></a>
<span class="sourceLineNo">1467</span>         * &lt;li&gt;&lt;code&gt;UTF-16LE&lt;/code&gt;&lt;br/&gt;<a name="line.1467"></a>
<span class="sourceLineNo">1468</span>         * Sixteen-bit Unicode Transformation Format, little-endian byte order.&lt;/li&gt;<a name="line.1468"></a>
<span class="sourceLineNo">1469</span>         * &lt;li&gt;&lt;code&gt;UTF-16&lt;/code&gt;&lt;br/&gt;<a name="line.1469"></a>
<span class="sourceLineNo">1470</span>         * Sixteen-bit Unicode Transformation Format, byte order specified by a<a name="line.1470"></a>
<span class="sourceLineNo">1471</span>         * mandatory initial byte-order mark (either order accepted on input,<a name="line.1471"></a>
<span class="sourceLineNo">1472</span>         * big-endian used on output.)&lt;/li&gt;<a name="line.1472"></a>
<span class="sourceLineNo">1473</span>         * &lt;/ul&gt;<a name="line.1473"></a>
<span class="sourceLineNo">1474</span>         * <a name="line.1474"></a>
<span class="sourceLineNo">1475</span>         * This perhaps would best belong in the Commons Lang project. Even if a<a name="line.1475"></a>
<span class="sourceLineNo">1476</span>         * similar class is defined in Commons Lang, it is not foreseen that Commons<a name="line.1476"></a>
<span class="sourceLineNo">1477</span>         * Codec would be made to depend on Commons Lang.<a name="line.1477"></a>
<span class="sourceLineNo">1478</span>         * <a name="line.1478"></a>
<span class="sourceLineNo">1479</span>         * &lt;p&gt;<a name="line.1479"></a>
<span class="sourceLineNo">1480</span>         * This class is immutable and thread-safe.<a name="line.1480"></a>
<span class="sourceLineNo">1481</span>         * &lt;/p&gt;<a name="line.1481"></a>
<span class="sourceLineNo">1482</span>         * <a name="line.1482"></a>
<span class="sourceLineNo">1483</span>         * @see &lt;a<a name="line.1483"></a>
<span class="sourceLineNo">1484</span>         *      href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1484"></a>
<span class="sourceLineNo">1485</span>         *      charsets&lt;/a&gt;<a name="line.1485"></a>
<span class="sourceLineNo">1486</span>         * @since 1.7<a name="line.1486"></a>
<span class="sourceLineNo">1487</span>         * @version $Id: CharEncoding.java 1173287 2011-09-20 18:16:19Z ggregory $<a name="line.1487"></a>
<span class="sourceLineNo">1488</span>         */<a name="line.1488"></a>
<span class="sourceLineNo">1489</span>        public static class Charsets {<a name="line.1489"></a>
<span class="sourceLineNo">1490</span><a name="line.1490"></a>
<span class="sourceLineNo">1491</span>                //<a name="line.1491"></a>
<span class="sourceLineNo">1492</span>                // This class should only contain Charset instances for required<a name="line.1492"></a>
<span class="sourceLineNo">1493</span>                // encodings. This guarantees that it will load correctly and<a name="line.1493"></a>
<span class="sourceLineNo">1494</span>                // without delay on all Java platforms.<a name="line.1494"></a>
<span class="sourceLineNo">1495</span>                //<a name="line.1495"></a>
<span class="sourceLineNo">1496</span><a name="line.1496"></a>
<span class="sourceLineNo">1497</span>                /**<a name="line.1497"></a>
<span class="sourceLineNo">1498</span>                 * Returns the given Charset or the default Charset if the given Charset<a name="line.1498"></a>
<span class="sourceLineNo">1499</span>                 * is null.<a name="line.1499"></a>
<span class="sourceLineNo">1500</span>                 * <a name="line.1500"></a>
<span class="sourceLineNo">1501</span>                 * @param charset<a name="line.1501"></a>
<span class="sourceLineNo">1502</span>                 *            A charset or null.<a name="line.1502"></a>
<span class="sourceLineNo">1503</span>                 * @return the given Charset or the default Charset if the given Charset<a name="line.1503"></a>
<span class="sourceLineNo">1504</span>                 *         is null<a name="line.1504"></a>
<span class="sourceLineNo">1505</span>                 */<a name="line.1505"></a>
<span class="sourceLineNo">1506</span>                public static Charset toCharset(Charset charset) {<a name="line.1506"></a>
<span class="sourceLineNo">1507</span>                        return charset == null ? Charset.defaultCharset() : charset;<a name="line.1507"></a>
<span class="sourceLineNo">1508</span>                }<a name="line.1508"></a>
<span class="sourceLineNo">1509</span><a name="line.1509"></a>
<span class="sourceLineNo">1510</span>                /**<a name="line.1510"></a>
<span class="sourceLineNo">1511</span>                 * Returns a Charset for the named charset. If the name is null, return<a name="line.1511"></a>
<span class="sourceLineNo">1512</span>                 * the default Charset.<a name="line.1512"></a>
<span class="sourceLineNo">1513</span>                 * <a name="line.1513"></a>
<span class="sourceLineNo">1514</span>                 * @param charset<a name="line.1514"></a>
<span class="sourceLineNo">1515</span>                 *            The name of the requested charset, may be null.<a name="line.1515"></a>
<span class="sourceLineNo">1516</span>                 * @return a Charset for the named charset<a name="line.1516"></a>
<span class="sourceLineNo">1517</span>                 * @throws UnsupportedCharsetException<a name="line.1517"></a>
<span class="sourceLineNo">1518</span>                 *             If the named charset is unavailable<a name="line.1518"></a>
<span class="sourceLineNo">1519</span>                 */<a name="line.1519"></a>
<span class="sourceLineNo">1520</span>                public static Charset toCharset(String charset) {<a name="line.1520"></a>
<span class="sourceLineNo">1521</span>                        return charset == null ? Charset.defaultCharset() : Charset.forName(charset);<a name="line.1521"></a>
<span class="sourceLineNo">1522</span>                }<a name="line.1522"></a>
<span class="sourceLineNo">1523</span><a name="line.1523"></a>
<span class="sourceLineNo">1524</span>                /**<a name="line.1524"></a>
<span class="sourceLineNo">1525</span>                 * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. &lt;/p&gt;<a name="line.1525"></a>
<span class="sourceLineNo">1526</span>                 * &lt;p&gt;<a name="line.1526"></a>
<span class="sourceLineNo">1527</span>                 * Every implementation of the Java platform is required to support this<a name="line.1527"></a>
<span class="sourceLineNo">1528</span>                 * character encoding.<a name="line.1528"></a>
<span class="sourceLineNo">1529</span>                 * &lt;/p&gt;<a name="line.1529"></a>
<span class="sourceLineNo">1530</span>                 * <a name="line.1530"></a>
<span class="sourceLineNo">1531</span>                 * @see &lt;a<a name="line.1531"></a>
<span class="sourceLineNo">1532</span>                 *      href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1532"></a>
<span class="sourceLineNo">1533</span>                 *      charsets&lt;/a&gt;<a name="line.1533"></a>
<span class="sourceLineNo">1534</span>                 */<a name="line.1534"></a>
<span class="sourceLineNo">1535</span>                public static final Charset ISO_8859_1 = Charset.forName(CharEncoding.ISO_8859_1);<a name="line.1535"></a>
<span class="sourceLineNo">1536</span><a name="line.1536"></a>
<span class="sourceLineNo">1537</span>                /**<a name="line.1537"></a>
<span class="sourceLineNo">1538</span>                 * &lt;p&gt;<a name="line.1538"></a>
<span class="sourceLineNo">1539</span>                 * Seven-bit ASCII, also known as ISO646-US, also known as the Basic<a name="line.1539"></a>
<span class="sourceLineNo">1540</span>                 * Latin block of the Unicode character set.<a name="line.1540"></a>
<span class="sourceLineNo">1541</span>                 * &lt;/p&gt;<a name="line.1541"></a>
<span class="sourceLineNo">1542</span>                 * &lt;p&gt;<a name="line.1542"></a>
<span class="sourceLineNo">1543</span>                 * Every implementation of the Java platform is required to support this<a name="line.1543"></a>
<span class="sourceLineNo">1544</span>                 * character encoding.<a name="line.1544"></a>
<span class="sourceLineNo">1545</span>                 * &lt;/p&gt;<a name="line.1545"></a>
<span class="sourceLineNo">1546</span>                 * <a name="line.1546"></a>
<span class="sourceLineNo">1547</span>                 * @see &lt;a<a name="line.1547"></a>
<span class="sourceLineNo">1548</span>                 *      href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1548"></a>
<span class="sourceLineNo">1549</span>                 *      charsets&lt;/a&gt;<a name="line.1549"></a>
<span class="sourceLineNo">1550</span>                 */<a name="line.1550"></a>
<span class="sourceLineNo">1551</span>                public static final Charset US_ASCII = Charset.forName(CharEncoding.US_ASCII);<a name="line.1551"></a>
<span class="sourceLineNo">1552</span><a name="line.1552"></a>
<span class="sourceLineNo">1553</span>                /**<a name="line.1553"></a>
<span class="sourceLineNo">1554</span>                 * &lt;p&gt;<a name="line.1554"></a>
<span class="sourceLineNo">1555</span>                 * Sixteen-bit Unicode Transformation Format, The byte order specified<a name="line.1555"></a>
<span class="sourceLineNo">1556</span>                 * by a mandatory initial byte-order mark (either order accepted on<a name="line.1556"></a>
<span class="sourceLineNo">1557</span>                 * input, big-endian used on output)<a name="line.1557"></a>
<span class="sourceLineNo">1558</span>                 * &lt;/p&gt;<a name="line.1558"></a>
<span class="sourceLineNo">1559</span>                 * &lt;p&gt;<a name="line.1559"></a>
<span class="sourceLineNo">1560</span>                 * Every implementation of the Java platform is required to support this<a name="line.1560"></a>
<span class="sourceLineNo">1561</span>                 * character encoding.<a name="line.1561"></a>
<span class="sourceLineNo">1562</span>                 * &lt;/p&gt;<a name="line.1562"></a>
<span class="sourceLineNo">1563</span>                 * <a name="line.1563"></a>
<span class="sourceLineNo">1564</span>                 * @see &lt;a<a name="line.1564"></a>
<span class="sourceLineNo">1565</span>                 *      href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1565"></a>
<span class="sourceLineNo">1566</span>                 *      charsets&lt;/a&gt;<a name="line.1566"></a>
<span class="sourceLineNo">1567</span>                 */<a name="line.1567"></a>
<span class="sourceLineNo">1568</span>                public static final Charset UTF_16 = Charset.forName(CharEncoding.UTF_16);<a name="line.1568"></a>
<span class="sourceLineNo">1569</span><a name="line.1569"></a>
<span class="sourceLineNo">1570</span>                /**<a name="line.1570"></a>
<span class="sourceLineNo">1571</span>                 * &lt;p&gt;<a name="line.1571"></a>
<span class="sourceLineNo">1572</span>                 * Sixteen-bit Unicode Transformation Format, big-endian byte order.<a name="line.1572"></a>
<span class="sourceLineNo">1573</span>                 * &lt;/p&gt;<a name="line.1573"></a>
<span class="sourceLineNo">1574</span>                 * &lt;p&gt;<a name="line.1574"></a>
<span class="sourceLineNo">1575</span>                 * Every implementation of the Java platform is required to support this<a name="line.1575"></a>
<span class="sourceLineNo">1576</span>                 * character encoding.<a name="line.1576"></a>
<span class="sourceLineNo">1577</span>                 * &lt;/p&gt;<a name="line.1577"></a>
<span class="sourceLineNo">1578</span>                 * <a name="line.1578"></a>
<span class="sourceLineNo">1579</span>                 * @see &lt;a<a name="line.1579"></a>
<span class="sourceLineNo">1580</span>                 *      href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1580"></a>
<span class="sourceLineNo">1581</span>                 *      charsets&lt;/a&gt;<a name="line.1581"></a>
<span class="sourceLineNo">1582</span>                 */<a name="line.1582"></a>
<span class="sourceLineNo">1583</span>                public static final Charset UTF_16BE = Charset.forName(CharEncoding.UTF_16BE);<a name="line.1583"></a>
<span class="sourceLineNo">1584</span><a name="line.1584"></a>
<span class="sourceLineNo">1585</span>                /**<a name="line.1585"></a>
<span class="sourceLineNo">1586</span>                 * &lt;p&gt;<a name="line.1586"></a>
<span class="sourceLineNo">1587</span>                 * Sixteen-bit Unicode Transformation Format, little-endian byte order.<a name="line.1587"></a>
<span class="sourceLineNo">1588</span>                 * &lt;/p&gt;<a name="line.1588"></a>
<span class="sourceLineNo">1589</span>                 * &lt;p&gt;<a name="line.1589"></a>
<span class="sourceLineNo">1590</span>                 * Every implementation of the Java platform is required to support this<a name="line.1590"></a>
<span class="sourceLineNo">1591</span>                 * character encoding.<a name="line.1591"></a>
<span class="sourceLineNo">1592</span>                 * &lt;/p&gt;<a name="line.1592"></a>
<span class="sourceLineNo">1593</span>                 * <a name="line.1593"></a>
<span class="sourceLineNo">1594</span>                 * @see &lt;a<a name="line.1594"></a>
<span class="sourceLineNo">1595</span>                 *      href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1595"></a>
<span class="sourceLineNo">1596</span>                 *      charsets&lt;/a&gt;<a name="line.1596"></a>
<span class="sourceLineNo">1597</span>                 */<a name="line.1597"></a>
<span class="sourceLineNo">1598</span>                public static final Charset UTF_16LE = Charset.forName(CharEncoding.UTF_16LE);<a name="line.1598"></a>
<span class="sourceLineNo">1599</span><a name="line.1599"></a>
<span class="sourceLineNo">1600</span>                /**<a name="line.1600"></a>
<span class="sourceLineNo">1601</span>                 * &lt;p&gt;<a name="line.1601"></a>
<span class="sourceLineNo">1602</span>                 * Eight-bit Unicode Transformation Format.<a name="line.1602"></a>
<span class="sourceLineNo">1603</span>                 * &lt;/p&gt;<a name="line.1603"></a>
<span class="sourceLineNo">1604</span>                 * &lt;p&gt;<a name="line.1604"></a>
<span class="sourceLineNo">1605</span>                 * Every implementation of the Java platform is required to support this<a name="line.1605"></a>
<span class="sourceLineNo">1606</span>                 * character encoding.<a name="line.1606"></a>
<span class="sourceLineNo">1607</span>                 * &lt;/p&gt;<a name="line.1607"></a>
<span class="sourceLineNo">1608</span>                 * <a name="line.1608"></a>
<span class="sourceLineNo">1609</span>                 * @see &lt;a<a name="line.1609"></a>
<span class="sourceLineNo">1610</span>                 *      href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1610"></a>
<span class="sourceLineNo">1611</span>                 *      charsets&lt;/a&gt;<a name="line.1611"></a>
<span class="sourceLineNo">1612</span>                 */<a name="line.1612"></a>
<span class="sourceLineNo">1613</span>                public static final Charset UTF_8 = Charset.forName(CharEncoding.UTF_8);<a name="line.1613"></a>
<span class="sourceLineNo">1614</span>        }<a name="line.1614"></a>
<span class="sourceLineNo">1615</span><a name="line.1615"></a>
<span class="sourceLineNo">1616</span>        /**<a name="line.1616"></a>
<span class="sourceLineNo">1617</span>         * Converts String to and from bytes using the encodings required by the<a name="line.1617"></a>
<span class="sourceLineNo">1618</span>         * Java specification. These encodings are specified in &lt;a href=<a name="line.1618"></a>
<span class="sourceLineNo">1619</span>         * "http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"<a name="line.1619"></a>
<span class="sourceLineNo">1620</span>         * &gt;Standard charsets&lt;/a&gt;<a name="line.1620"></a>
<span class="sourceLineNo">1621</span>         * <a name="line.1621"></a>
<span class="sourceLineNo">1622</span>         * &lt;p&gt;<a name="line.1622"></a>
<span class="sourceLineNo">1623</span>         * This class is immutable and thread-safe.<a name="line.1623"></a>
<span class="sourceLineNo">1624</span>         * &lt;/p&gt;<a name="line.1624"></a>
<span class="sourceLineNo">1625</span>         * <a name="line.1625"></a>
<span class="sourceLineNo">1626</span>         * @see CharEncoding<a name="line.1626"></a>
<span class="sourceLineNo">1627</span>         * @see &lt;a<a name="line.1627"></a>
<span class="sourceLineNo">1628</span>         *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1628"></a>
<span class="sourceLineNo">1629</span>         *      charsets&lt;/a&gt;<a name="line.1629"></a>
<span class="sourceLineNo">1630</span>         * @version $Id$<a name="line.1630"></a>
<span class="sourceLineNo">1631</span>         * @since 1.4<a name="line.1631"></a>
<span class="sourceLineNo">1632</span>         */<a name="line.1632"></a>
<span class="sourceLineNo">1633</span>        public static class StringUtils {<a name="line.1633"></a>
<span class="sourceLineNo">1634</span><a name="line.1634"></a>
<span class="sourceLineNo">1635</span>                /**<a name="line.1635"></a>
<span class="sourceLineNo">1636</span>                 * Calls {@link String#getBytes(Charset)}<a name="line.1636"></a>
<span class="sourceLineNo">1637</span>                 * <a name="line.1637"></a>
<span class="sourceLineNo">1638</span>                 * @param string<a name="line.1638"></a>
<span class="sourceLineNo">1639</span>                 *            The string to encode (if null, return null).<a name="line.1639"></a>
<span class="sourceLineNo">1640</span>                 * @param charset<a name="line.1640"></a>
<span class="sourceLineNo">1641</span>                 *            The {@link Charset} to encode the {@code String}<a name="line.1641"></a>
<span class="sourceLineNo">1642</span>                 * @return the encoded bytes<a name="line.1642"></a>
<span class="sourceLineNo">1643</span>                 */<a name="line.1643"></a>
<span class="sourceLineNo">1644</span>                private static byte[] getBytes(String string, Charset charset) {<a name="line.1644"></a>
<span class="sourceLineNo">1645</span>                        if (string == null) {<a name="line.1645"></a>
<span class="sourceLineNo">1646</span>                                return null;<a name="line.1646"></a>
<span class="sourceLineNo">1647</span>                        }<a name="line.1647"></a>
<span class="sourceLineNo">1648</span>                        return string.getBytes(charset);<a name="line.1648"></a>
<span class="sourceLineNo">1649</span>                }<a name="line.1649"></a>
<span class="sourceLineNo">1650</span><a name="line.1650"></a>
<span class="sourceLineNo">1651</span>                /**<a name="line.1651"></a>
<span class="sourceLineNo">1652</span>                 * Encodes the given string into a sequence of bytes using the<a name="line.1652"></a>
<span class="sourceLineNo">1653</span>                 * ISO-8859-1 charset, storing the result into a new byte array.<a name="line.1653"></a>
<span class="sourceLineNo">1654</span>                 * <a name="line.1654"></a>
<span class="sourceLineNo">1655</span>                 * @param string<a name="line.1655"></a>
<span class="sourceLineNo">1656</span>                 *            the String to encode, may be {@code null}<a name="line.1656"></a>
<span class="sourceLineNo">1657</span>                 * @return encoded bytes, or {@code null} if the input string was<a name="line.1657"></a>
<span class="sourceLineNo">1658</span>                 *         {@code null}<a name="line.1658"></a>
<span class="sourceLineNo">1659</span>                 * @throws NullPointerException<a name="line.1659"></a>
<span class="sourceLineNo">1660</span>                 *             Thrown if {@link Charsets#ISO_8859_1} is not initialized,<a name="line.1660"></a>
<span class="sourceLineNo">1661</span>                 *             which should never happen since it is required by the<a name="line.1661"></a>
<span class="sourceLineNo">1662</span>                 *             Java platform specification.<a name="line.1662"></a>
<span class="sourceLineNo">1663</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1663"></a>
<span class="sourceLineNo">1664</span>                 *        UnsupportedEncodingException<a name="line.1664"></a>
<span class="sourceLineNo">1665</span>                 * @see &lt;a<a name="line.1665"></a>
<span class="sourceLineNo">1666</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1666"></a>
<span class="sourceLineNo">1667</span>                 *      charsets&lt;/a&gt;<a name="line.1667"></a>
<span class="sourceLineNo">1668</span>                 * @see #getBytesUnchecked(String, String)<a name="line.1668"></a>
<span class="sourceLineNo">1669</span>                 */<a name="line.1669"></a>
<span class="sourceLineNo">1670</span>                public static byte[] getBytesIso8859_1(String string) {<a name="line.1670"></a>
<span class="sourceLineNo">1671</span>                        return getBytes(string, Charsets.ISO_8859_1);<a name="line.1671"></a>
<span class="sourceLineNo">1672</span>                }<a name="line.1672"></a>
<span class="sourceLineNo">1673</span><a name="line.1673"></a>
<span class="sourceLineNo">1674</span>                /**<a name="line.1674"></a>
<span class="sourceLineNo">1675</span>                 * Encodes the given string into a sequence of bytes using the named<a name="line.1675"></a>
<span class="sourceLineNo">1676</span>                 * charset, storing the result into a new byte array.<a name="line.1676"></a>
<span class="sourceLineNo">1677</span>                 * &lt;p&gt;<a name="line.1677"></a>
<span class="sourceLineNo">1678</span>                 * This method catches {@link UnsupportedEncodingException} and rethrows<a name="line.1678"></a>
<span class="sourceLineNo">1679</span>                 * it as {@link IllegalStateException}, which should never happen for a<a name="line.1679"></a>
<span class="sourceLineNo">1680</span>                 * required charset name. Use this method when the encoding is required<a name="line.1680"></a>
<span class="sourceLineNo">1681</span>                 * to be in the JRE.<a name="line.1681"></a>
<span class="sourceLineNo">1682</span>                 * &lt;/p&gt;<a name="line.1682"></a>
<span class="sourceLineNo">1683</span>                 * <a name="line.1683"></a>
<span class="sourceLineNo">1684</span>                 * @param string<a name="line.1684"></a>
<span class="sourceLineNo">1685</span>                 *            the String to encode, may be {@code null}<a name="line.1685"></a>
<span class="sourceLineNo">1686</span>                 * @param charsetName<a name="line.1686"></a>
<span class="sourceLineNo">1687</span>                 *            The name of a required {@link java.nio.charset.Charset}<a name="line.1687"></a>
<span class="sourceLineNo">1688</span>                 * @return encoded bytes, or {@code null} if the input string was<a name="line.1688"></a>
<span class="sourceLineNo">1689</span>                 *         {@code null}<a name="line.1689"></a>
<span class="sourceLineNo">1690</span>                 * @throws IllegalStateException<a name="line.1690"></a>
<span class="sourceLineNo">1691</span>                 *             Thrown when a {@link UnsupportedEncodingException} is<a name="line.1691"></a>
<span class="sourceLineNo">1692</span>                 *             caught, which should never happen for a required charset<a name="line.1692"></a>
<span class="sourceLineNo">1693</span>                 *             name.<a name="line.1693"></a>
<span class="sourceLineNo">1694</span>                 * @see CharEncoding<a name="line.1694"></a>
<span class="sourceLineNo">1695</span>                 * @see String#getBytes(String)<a name="line.1695"></a>
<span class="sourceLineNo">1696</span>                 */<a name="line.1696"></a>
<span class="sourceLineNo">1697</span>                public static byte[] getBytesUnchecked(String string, String charsetName) {<a name="line.1697"></a>
<span class="sourceLineNo">1698</span>                        if (string == null) {<a name="line.1698"></a>
<span class="sourceLineNo">1699</span>                                return null;<a name="line.1699"></a>
<span class="sourceLineNo">1700</span>                        }<a name="line.1700"></a>
<span class="sourceLineNo">1701</span>                        try {<a name="line.1701"></a>
<span class="sourceLineNo">1702</span>                                return string.getBytes(charsetName);<a name="line.1702"></a>
<span class="sourceLineNo">1703</span>                        } catch (UnsupportedEncodingException e) {<a name="line.1703"></a>
<span class="sourceLineNo">1704</span>                                throw StringUtils.newIllegalStateException(charsetName, e);<a name="line.1704"></a>
<span class="sourceLineNo">1705</span>                        }<a name="line.1705"></a>
<span class="sourceLineNo">1706</span>                }<a name="line.1706"></a>
<span class="sourceLineNo">1707</span><a name="line.1707"></a>
<span class="sourceLineNo">1708</span>                /**<a name="line.1708"></a>
<span class="sourceLineNo">1709</span>                 * Encodes the given string into a sequence of bytes using the US-ASCII<a name="line.1709"></a>
<span class="sourceLineNo">1710</span>                 * charset, storing the result into a new byte array.<a name="line.1710"></a>
<span class="sourceLineNo">1711</span>                 * <a name="line.1711"></a>
<span class="sourceLineNo">1712</span>                 * @param string<a name="line.1712"></a>
<span class="sourceLineNo">1713</span>                 *            the String to encode, may be {@code null}<a name="line.1713"></a>
<span class="sourceLineNo">1714</span>                 * @return encoded bytes, or {@code null} if the input string was<a name="line.1714"></a>
<span class="sourceLineNo">1715</span>                 *         {@code null}<a name="line.1715"></a>
<span class="sourceLineNo">1716</span>                 * @throws NullPointerException<a name="line.1716"></a>
<span class="sourceLineNo">1717</span>                 *             Thrown if {@link Charsets#US_ASCII} is not initialized,<a name="line.1717"></a>
<span class="sourceLineNo">1718</span>                 *             which should never happen since it is required by the<a name="line.1718"></a>
<span class="sourceLineNo">1719</span>                 *             Java platform specification.<a name="line.1719"></a>
<span class="sourceLineNo">1720</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1720"></a>
<span class="sourceLineNo">1721</span>                 *        UnsupportedEncodingException<a name="line.1721"></a>
<span class="sourceLineNo">1722</span>                 * @see &lt;a<a name="line.1722"></a>
<span class="sourceLineNo">1723</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1723"></a>
<span class="sourceLineNo">1724</span>                 *      charsets&lt;/a&gt;<a name="line.1724"></a>
<span class="sourceLineNo">1725</span>                 * @see #getBytesUnchecked(String, String)<a name="line.1725"></a>
<span class="sourceLineNo">1726</span>                 */<a name="line.1726"></a>
<span class="sourceLineNo">1727</span>                public static byte[] getBytesUsAscii(String string) {<a name="line.1727"></a>
<span class="sourceLineNo">1728</span>                        return getBytes(string, Charsets.US_ASCII);<a name="line.1728"></a>
<span class="sourceLineNo">1729</span>                }<a name="line.1729"></a>
<span class="sourceLineNo">1730</span><a name="line.1730"></a>
<span class="sourceLineNo">1731</span>                /**<a name="line.1731"></a>
<span class="sourceLineNo">1732</span>                 * Encodes the given string into a sequence of bytes using the UTF-16<a name="line.1732"></a>
<span class="sourceLineNo">1733</span>                 * charset, storing the result into a new byte array.<a name="line.1733"></a>
<span class="sourceLineNo">1734</span>                 * <a name="line.1734"></a>
<span class="sourceLineNo">1735</span>                 * @param string<a name="line.1735"></a>
<span class="sourceLineNo">1736</span>                 *            the String to encode, may be {@code null}<a name="line.1736"></a>
<span class="sourceLineNo">1737</span>                 * @return encoded bytes, or {@code null} if the input string was<a name="line.1737"></a>
<span class="sourceLineNo">1738</span>                 *         {@code null}<a name="line.1738"></a>
<span class="sourceLineNo">1739</span>                 * @throws NullPointerException<a name="line.1739"></a>
<span class="sourceLineNo">1740</span>                 *             Thrown if {@link Charsets#UTF_16} is not initialized,<a name="line.1740"></a>
<span class="sourceLineNo">1741</span>                 *             which should never happen since it is required by the<a name="line.1741"></a>
<span class="sourceLineNo">1742</span>                 *             Java platform specification.<a name="line.1742"></a>
<span class="sourceLineNo">1743</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1743"></a>
<span class="sourceLineNo">1744</span>                 *        UnsupportedEncodingException<a name="line.1744"></a>
<span class="sourceLineNo">1745</span>                 * @see &lt;a<a name="line.1745"></a>
<span class="sourceLineNo">1746</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1746"></a>
<span class="sourceLineNo">1747</span>                 *      charsets&lt;/a&gt;<a name="line.1747"></a>
<span class="sourceLineNo">1748</span>                 * @see #getBytesUnchecked(String, String)<a name="line.1748"></a>
<span class="sourceLineNo">1749</span>                 */<a name="line.1749"></a>
<span class="sourceLineNo">1750</span>                public static byte[] getBytesUtf16(String string) {<a name="line.1750"></a>
<span class="sourceLineNo">1751</span>                        return getBytes(string, Charsets.UTF_16);<a name="line.1751"></a>
<span class="sourceLineNo">1752</span>                }<a name="line.1752"></a>
<span class="sourceLineNo">1753</span><a name="line.1753"></a>
<span class="sourceLineNo">1754</span>                /**<a name="line.1754"></a>
<span class="sourceLineNo">1755</span>                 * Encodes the given string into a sequence of bytes using the UTF-16BE<a name="line.1755"></a>
<span class="sourceLineNo">1756</span>                 * charset, storing the result into a new byte array.<a name="line.1756"></a>
<span class="sourceLineNo">1757</span>                 * <a name="line.1757"></a>
<span class="sourceLineNo">1758</span>                 * @param string<a name="line.1758"></a>
<span class="sourceLineNo">1759</span>                 *            the String to encode, may be {@code null}<a name="line.1759"></a>
<span class="sourceLineNo">1760</span>                 * @return encoded bytes, or {@code null} if the input string was<a name="line.1760"></a>
<span class="sourceLineNo">1761</span>                 *         {@code null}<a name="line.1761"></a>
<span class="sourceLineNo">1762</span>                 * @throws NullPointerException<a name="line.1762"></a>
<span class="sourceLineNo">1763</span>                 *             Thrown if {@link Charsets#UTF_16BE} is not initialized,<a name="line.1763"></a>
<span class="sourceLineNo">1764</span>                 *             which should never happen since it is required by the<a name="line.1764"></a>
<span class="sourceLineNo">1765</span>                 *             Java platform specification.<a name="line.1765"></a>
<span class="sourceLineNo">1766</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1766"></a>
<span class="sourceLineNo">1767</span>                 *        UnsupportedEncodingException<a name="line.1767"></a>
<span class="sourceLineNo">1768</span>                 * @see &lt;a<a name="line.1768"></a>
<span class="sourceLineNo">1769</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1769"></a>
<span class="sourceLineNo">1770</span>                 *      charsets&lt;/a&gt;<a name="line.1770"></a>
<span class="sourceLineNo">1771</span>                 * @see #getBytesUnchecked(String, String)<a name="line.1771"></a>
<span class="sourceLineNo">1772</span>                 */<a name="line.1772"></a>
<span class="sourceLineNo">1773</span>                public static byte[] getBytesUtf16Be(String string) {<a name="line.1773"></a>
<span class="sourceLineNo">1774</span>                        return getBytes(string, Charsets.UTF_16BE);<a name="line.1774"></a>
<span class="sourceLineNo">1775</span>                }<a name="line.1775"></a>
<span class="sourceLineNo">1776</span><a name="line.1776"></a>
<span class="sourceLineNo">1777</span>                /**<a name="line.1777"></a>
<span class="sourceLineNo">1778</span>                 * Encodes the given string into a sequence of bytes using the UTF-16LE<a name="line.1778"></a>
<span class="sourceLineNo">1779</span>                 * charset, storing the result into a new byte array.<a name="line.1779"></a>
<span class="sourceLineNo">1780</span>                 * <a name="line.1780"></a>
<span class="sourceLineNo">1781</span>                 * @param string<a name="line.1781"></a>
<span class="sourceLineNo">1782</span>                 *            the String to encode, may be {@code null}<a name="line.1782"></a>
<span class="sourceLineNo">1783</span>                 * @return encoded bytes, or {@code null} if the input string was<a name="line.1783"></a>
<span class="sourceLineNo">1784</span>                 *         {@code null}<a name="line.1784"></a>
<span class="sourceLineNo">1785</span>                 * @throws NullPointerException<a name="line.1785"></a>
<span class="sourceLineNo">1786</span>                 *             Thrown if {@link Charsets#UTF_16LE} is not initialized,<a name="line.1786"></a>
<span class="sourceLineNo">1787</span>                 *             which should never happen since it is required by the<a name="line.1787"></a>
<span class="sourceLineNo">1788</span>                 *             Java platform specification.<a name="line.1788"></a>
<span class="sourceLineNo">1789</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1789"></a>
<span class="sourceLineNo">1790</span>                 *        UnsupportedEncodingException<a name="line.1790"></a>
<span class="sourceLineNo">1791</span>                 * @see &lt;a<a name="line.1791"></a>
<span class="sourceLineNo">1792</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1792"></a>
<span class="sourceLineNo">1793</span>                 *      charsets&lt;/a&gt;<a name="line.1793"></a>
<span class="sourceLineNo">1794</span>                 * @see #getBytesUnchecked(String, String)<a name="line.1794"></a>
<span class="sourceLineNo">1795</span>                 */<a name="line.1795"></a>
<span class="sourceLineNo">1796</span>                public static byte[] getBytesUtf16Le(String string) {<a name="line.1796"></a>
<span class="sourceLineNo">1797</span>                        return getBytes(string, Charsets.UTF_16LE);<a name="line.1797"></a>
<span class="sourceLineNo">1798</span>                }<a name="line.1798"></a>
<span class="sourceLineNo">1799</span><a name="line.1799"></a>
<span class="sourceLineNo">1800</span>                /**<a name="line.1800"></a>
<span class="sourceLineNo">1801</span>                 * Encodes the given string into a sequence of bytes using the UTF-8<a name="line.1801"></a>
<span class="sourceLineNo">1802</span>                 * charset, storing the result into a new byte array.<a name="line.1802"></a>
<span class="sourceLineNo">1803</span>                 * <a name="line.1803"></a>
<span class="sourceLineNo">1804</span>                 * @param string<a name="line.1804"></a>
<span class="sourceLineNo">1805</span>                 *            the String to encode, may be {@code null}<a name="line.1805"></a>
<span class="sourceLineNo">1806</span>                 * @return encoded bytes, or {@code null} if the input string was<a name="line.1806"></a>
<span class="sourceLineNo">1807</span>                 *         {@code null}<a name="line.1807"></a>
<span class="sourceLineNo">1808</span>                 * @throws NullPointerException<a name="line.1808"></a>
<span class="sourceLineNo">1809</span>                 *             Thrown if {@link Charsets#UTF_8} is not initialized,<a name="line.1809"></a>
<span class="sourceLineNo">1810</span>                 *             which should never happen since it is required by the<a name="line.1810"></a>
<span class="sourceLineNo">1811</span>                 *             Java platform specification.<a name="line.1811"></a>
<span class="sourceLineNo">1812</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1812"></a>
<span class="sourceLineNo">1813</span>                 *        UnsupportedEncodingException<a name="line.1813"></a>
<span class="sourceLineNo">1814</span>                 * @see &lt;a<a name="line.1814"></a>
<span class="sourceLineNo">1815</span>                 *      href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html"&gt;Standard<a name="line.1815"></a>
<span class="sourceLineNo">1816</span>                 *      charsets&lt;/a&gt;<a name="line.1816"></a>
<span class="sourceLineNo">1817</span>                 * @see #getBytesUnchecked(String, String)<a name="line.1817"></a>
<span class="sourceLineNo">1818</span>                 */<a name="line.1818"></a>
<span class="sourceLineNo">1819</span>                public static byte[] getBytesUtf8(String string) {<a name="line.1819"></a>
<span class="sourceLineNo">1820</span>                        return getBytes(string, Charsets.UTF_8);<a name="line.1820"></a>
<span class="sourceLineNo">1821</span>                }<a name="line.1821"></a>
<span class="sourceLineNo">1822</span><a name="line.1822"></a>
<span class="sourceLineNo">1823</span>                private static IllegalStateException newIllegalStateException(String charsetName, UnsupportedEncodingException e) {<a name="line.1823"></a>
<span class="sourceLineNo">1824</span>                        return new IllegalStateException(charsetName + ": " + e);<a name="line.1824"></a>
<span class="sourceLineNo">1825</span>                }<a name="line.1825"></a>
<span class="sourceLineNo">1826</span><a name="line.1826"></a>
<span class="sourceLineNo">1827</span>                /**<a name="line.1827"></a>
<span class="sourceLineNo">1828</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1828"></a>
<span class="sourceLineNo">1829</span>                 * of bytes using the given charset.<a name="line.1829"></a>
<span class="sourceLineNo">1830</span>                 * <a name="line.1830"></a>
<span class="sourceLineNo">1831</span>                 * @param bytes<a name="line.1831"></a>
<span class="sourceLineNo">1832</span>                 *            The bytes to be decoded into characters<a name="line.1832"></a>
<span class="sourceLineNo">1833</span>                 * @param charset<a name="line.1833"></a>
<span class="sourceLineNo">1834</span>                 *            The {@link Charset} to encode the {@code String}<a name="line.1834"></a>
<span class="sourceLineNo">1835</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1835"></a>
<span class="sourceLineNo">1836</span>                 *         bytes using the given charset, or {@code null} if the input<a name="line.1836"></a>
<span class="sourceLineNo">1837</span>                 *         byte array was {@code null}.<a name="line.1837"></a>
<span class="sourceLineNo">1838</span>                 * @throws NullPointerException<a name="line.1838"></a>
<span class="sourceLineNo">1839</span>                 *             Thrown if {@link Charsets#UTF_8} is not initialized,<a name="line.1839"></a>
<span class="sourceLineNo">1840</span>                 *             which should never happen since it is required by the<a name="line.1840"></a>
<span class="sourceLineNo">1841</span>                 *             Java platform specification.<a name="line.1841"></a>
<span class="sourceLineNo">1842</span>                 */<a name="line.1842"></a>
<span class="sourceLineNo">1843</span>                private static String newString(byte[] bytes, Charset charset) {<a name="line.1843"></a>
<span class="sourceLineNo">1844</span>                        return bytes == null ? null : new String(bytes, charset);<a name="line.1844"></a>
<span class="sourceLineNo">1845</span>                }<a name="line.1845"></a>
<span class="sourceLineNo">1846</span><a name="line.1846"></a>
<span class="sourceLineNo">1847</span>                /**<a name="line.1847"></a>
<span class="sourceLineNo">1848</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1848"></a>
<span class="sourceLineNo">1849</span>                 * of bytes using the given charset.<a name="line.1849"></a>
<span class="sourceLineNo">1850</span>                 * &lt;p&gt;<a name="line.1850"></a>
<span class="sourceLineNo">1851</span>                 * This method catches {@link UnsupportedEncodingException} and<a name="line.1851"></a>
<span class="sourceLineNo">1852</span>                 * re-throws it as {@link IllegalStateException}, which should never<a name="line.1852"></a>
<span class="sourceLineNo">1853</span>                 * happen for a required charset name. Use this method when the encoding<a name="line.1853"></a>
<span class="sourceLineNo">1854</span>                 * is required to be in the JRE.<a name="line.1854"></a>
<span class="sourceLineNo">1855</span>                 * &lt;/p&gt;<a name="line.1855"></a>
<span class="sourceLineNo">1856</span>                 * <a name="line.1856"></a>
<span class="sourceLineNo">1857</span>                 * @param bytes<a name="line.1857"></a>
<span class="sourceLineNo">1858</span>                 *            The bytes to be decoded into characters, may be<a name="line.1858"></a>
<span class="sourceLineNo">1859</span>                 *            {@code null}<a name="line.1859"></a>
<span class="sourceLineNo">1860</span>                 * @param charsetName<a name="line.1860"></a>
<span class="sourceLineNo">1861</span>                 *            The name of a required {@link java.nio.charset.Charset}<a name="line.1861"></a>
<span class="sourceLineNo">1862</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1862"></a>
<span class="sourceLineNo">1863</span>                 *         bytes using the given charset, or {@code null} if the input<a name="line.1863"></a>
<span class="sourceLineNo">1864</span>                 *         byte array was {@code null}.<a name="line.1864"></a>
<span class="sourceLineNo">1865</span>                 * @throws IllegalStateException<a name="line.1865"></a>
<span class="sourceLineNo">1866</span>                 *             Thrown when a {@link UnsupportedEncodingException} is<a name="line.1866"></a>
<span class="sourceLineNo">1867</span>                 *             caught, which should never happen for a required charset<a name="line.1867"></a>
<span class="sourceLineNo">1868</span>                 *             name.<a name="line.1868"></a>
<span class="sourceLineNo">1869</span>                 * @see CharEncoding<a name="line.1869"></a>
<span class="sourceLineNo">1870</span>                 * @see String#String(byte[], String)<a name="line.1870"></a>
<span class="sourceLineNo">1871</span>                 */<a name="line.1871"></a>
<span class="sourceLineNo">1872</span>                public static String newString(byte[] bytes, String charsetName) {<a name="line.1872"></a>
<span class="sourceLineNo">1873</span>                        if (bytes == null) {<a name="line.1873"></a>
<span class="sourceLineNo">1874</span>                                return null;<a name="line.1874"></a>
<span class="sourceLineNo">1875</span>                        }<a name="line.1875"></a>
<span class="sourceLineNo">1876</span>                        try {<a name="line.1876"></a>
<span class="sourceLineNo">1877</span>                                return new String(bytes, charsetName);<a name="line.1877"></a>
<span class="sourceLineNo">1878</span>                        } catch (UnsupportedEncodingException e) {<a name="line.1878"></a>
<span class="sourceLineNo">1879</span>                                throw StringUtils.newIllegalStateException(charsetName, e);<a name="line.1879"></a>
<span class="sourceLineNo">1880</span>                        }<a name="line.1880"></a>
<span class="sourceLineNo">1881</span>                }<a name="line.1881"></a>
<span class="sourceLineNo">1882</span><a name="line.1882"></a>
<span class="sourceLineNo">1883</span>                /**<a name="line.1883"></a>
<span class="sourceLineNo">1884</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1884"></a>
<span class="sourceLineNo">1885</span>                 * of bytes using the ISO-8859-1 charset.<a name="line.1885"></a>
<span class="sourceLineNo">1886</span>                 * <a name="line.1886"></a>
<span class="sourceLineNo">1887</span>                 * @param bytes<a name="line.1887"></a>
<span class="sourceLineNo">1888</span>                 *            The bytes to be decoded into characters, may be<a name="line.1888"></a>
<span class="sourceLineNo">1889</span>                 *            {@code null}<a name="line.1889"></a>
<span class="sourceLineNo">1890</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1890"></a>
<span class="sourceLineNo">1891</span>                 *         bytes using the ISO-8859-1 charset, or {@code null} if the<a name="line.1891"></a>
<span class="sourceLineNo">1892</span>                 *         input byte array was {@code null}.<a name="line.1892"></a>
<span class="sourceLineNo">1893</span>                 * @throws NullPointerException<a name="line.1893"></a>
<span class="sourceLineNo">1894</span>                 *             Thrown if {@link Charsets#ISO_8859_1} is not initialized,<a name="line.1894"></a>
<span class="sourceLineNo">1895</span>                 *             which should never happen since it is required by the<a name="line.1895"></a>
<span class="sourceLineNo">1896</span>                 *             Java platform specification.<a name="line.1896"></a>
<span class="sourceLineNo">1897</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1897"></a>
<span class="sourceLineNo">1898</span>                 *        UnsupportedEncodingException<a name="line.1898"></a>
<span class="sourceLineNo">1899</span>                 */<a name="line.1899"></a>
<span class="sourceLineNo">1900</span>                public static String newStringIso8859_1(byte[] bytes) {<a name="line.1900"></a>
<span class="sourceLineNo">1901</span>                        return new String(bytes, Charsets.ISO_8859_1);<a name="line.1901"></a>
<span class="sourceLineNo">1902</span>                }<a name="line.1902"></a>
<span class="sourceLineNo">1903</span><a name="line.1903"></a>
<span class="sourceLineNo">1904</span>                /**<a name="line.1904"></a>
<span class="sourceLineNo">1905</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1905"></a>
<span class="sourceLineNo">1906</span>                 * of bytes using the US-ASCII charset.<a name="line.1906"></a>
<span class="sourceLineNo">1907</span>                 * <a name="line.1907"></a>
<span class="sourceLineNo">1908</span>                 * @param bytes<a name="line.1908"></a>
<span class="sourceLineNo">1909</span>                 *            The bytes to be decoded into characters<a name="line.1909"></a>
<span class="sourceLineNo">1910</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1910"></a>
<span class="sourceLineNo">1911</span>                 *         bytes using the US-ASCII charset, or {@code null} if the<a name="line.1911"></a>
<span class="sourceLineNo">1912</span>                 *         input byte array was {@code null}.<a name="line.1912"></a>
<span class="sourceLineNo">1913</span>                 * @throws NullPointerException<a name="line.1913"></a>
<span class="sourceLineNo">1914</span>                 *             Thrown if {@link Charsets#US_ASCII} is not initialized,<a name="line.1914"></a>
<span class="sourceLineNo">1915</span>                 *             which should never happen since it is required by the<a name="line.1915"></a>
<span class="sourceLineNo">1916</span>                 *             Java platform specification.<a name="line.1916"></a>
<span class="sourceLineNo">1917</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1917"></a>
<span class="sourceLineNo">1918</span>                 *        UnsupportedEncodingException<a name="line.1918"></a>
<span class="sourceLineNo">1919</span>                 */<a name="line.1919"></a>
<span class="sourceLineNo">1920</span>                public static String newStringUsAscii(byte[] bytes) {<a name="line.1920"></a>
<span class="sourceLineNo">1921</span>                        return new String(bytes, Charsets.US_ASCII);<a name="line.1921"></a>
<span class="sourceLineNo">1922</span>                }<a name="line.1922"></a>
<span class="sourceLineNo">1923</span><a name="line.1923"></a>
<span class="sourceLineNo">1924</span>                /**<a name="line.1924"></a>
<span class="sourceLineNo">1925</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1925"></a>
<span class="sourceLineNo">1926</span>                 * of bytes using the UTF-16 charset.<a name="line.1926"></a>
<span class="sourceLineNo">1927</span>                 * <a name="line.1927"></a>
<span class="sourceLineNo">1928</span>                 * @param bytes<a name="line.1928"></a>
<span class="sourceLineNo">1929</span>                 *            The bytes to be decoded into characters<a name="line.1929"></a>
<span class="sourceLineNo">1930</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1930"></a>
<span class="sourceLineNo">1931</span>                 *         bytes using the UTF-16 charset or {@code null} if the input<a name="line.1931"></a>
<span class="sourceLineNo">1932</span>                 *         byte array was {@code null}.<a name="line.1932"></a>
<span class="sourceLineNo">1933</span>                 * @throws NullPointerException<a name="line.1933"></a>
<span class="sourceLineNo">1934</span>                 *             Thrown if {@link Charsets#UTF_16} is not initialized,<a name="line.1934"></a>
<span class="sourceLineNo">1935</span>                 *             which should never happen since it is required by the<a name="line.1935"></a>
<span class="sourceLineNo">1936</span>                 *             Java platform specification.<a name="line.1936"></a>
<span class="sourceLineNo">1937</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1937"></a>
<span class="sourceLineNo">1938</span>                 *        UnsupportedEncodingException<a name="line.1938"></a>
<span class="sourceLineNo">1939</span>                 */<a name="line.1939"></a>
<span class="sourceLineNo">1940</span>                public static String newStringUtf16(byte[] bytes) {<a name="line.1940"></a>
<span class="sourceLineNo">1941</span>                        return new String(bytes, Charsets.UTF_16);<a name="line.1941"></a>
<span class="sourceLineNo">1942</span>                }<a name="line.1942"></a>
<span class="sourceLineNo">1943</span><a name="line.1943"></a>
<span class="sourceLineNo">1944</span>                /**<a name="line.1944"></a>
<span class="sourceLineNo">1945</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1945"></a>
<span class="sourceLineNo">1946</span>                 * of bytes using the UTF-16BE charset.<a name="line.1946"></a>
<span class="sourceLineNo">1947</span>                 * <a name="line.1947"></a>
<span class="sourceLineNo">1948</span>                 * @param bytes<a name="line.1948"></a>
<span class="sourceLineNo">1949</span>                 *            The bytes to be decoded into characters<a name="line.1949"></a>
<span class="sourceLineNo">1950</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1950"></a>
<span class="sourceLineNo">1951</span>                 *         bytes using the UTF-16BE charset, or {@code null} if the<a name="line.1951"></a>
<span class="sourceLineNo">1952</span>                 *         input byte array was {@code null}.<a name="line.1952"></a>
<span class="sourceLineNo">1953</span>                 * @throws NullPointerException<a name="line.1953"></a>
<span class="sourceLineNo">1954</span>                 *             Thrown if {@link Charsets#UTF_16BE} is not initialized,<a name="line.1954"></a>
<span class="sourceLineNo">1955</span>                 *             which should never happen since it is required by the<a name="line.1955"></a>
<span class="sourceLineNo">1956</span>                 *             Java platform specification.<a name="line.1956"></a>
<span class="sourceLineNo">1957</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1957"></a>
<span class="sourceLineNo">1958</span>                 *        UnsupportedEncodingException<a name="line.1958"></a>
<span class="sourceLineNo">1959</span>                 */<a name="line.1959"></a>
<span class="sourceLineNo">1960</span>                public static String newStringUtf16Be(byte[] bytes) {<a name="line.1960"></a>
<span class="sourceLineNo">1961</span>                        return new String(bytes, Charsets.UTF_16BE);<a name="line.1961"></a>
<span class="sourceLineNo">1962</span>                }<a name="line.1962"></a>
<span class="sourceLineNo">1963</span><a name="line.1963"></a>
<span class="sourceLineNo">1964</span>                /**<a name="line.1964"></a>
<span class="sourceLineNo">1965</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1965"></a>
<span class="sourceLineNo">1966</span>                 * of bytes using the UTF-16LE charset.<a name="line.1966"></a>
<span class="sourceLineNo">1967</span>                 * <a name="line.1967"></a>
<span class="sourceLineNo">1968</span>                 * @param bytes<a name="line.1968"></a>
<span class="sourceLineNo">1969</span>                 *            The bytes to be decoded into characters<a name="line.1969"></a>
<span class="sourceLineNo">1970</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1970"></a>
<span class="sourceLineNo">1971</span>                 *         bytes using the UTF-16LE charset, or {@code null} if the<a name="line.1971"></a>
<span class="sourceLineNo">1972</span>                 *         input byte array was {@code null}.<a name="line.1972"></a>
<span class="sourceLineNo">1973</span>                 * @throws NullPointerException<a name="line.1973"></a>
<span class="sourceLineNo">1974</span>                 *             Thrown if {@link Charsets#UTF_16LE} is not initialized,<a name="line.1974"></a>
<span class="sourceLineNo">1975</span>                 *             which should never happen since it is required by the<a name="line.1975"></a>
<span class="sourceLineNo">1976</span>                 *             Java platform specification.<a name="line.1976"></a>
<span class="sourceLineNo">1977</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1977"></a>
<span class="sourceLineNo">1978</span>                 *        UnsupportedEncodingException<a name="line.1978"></a>
<span class="sourceLineNo">1979</span>                 */<a name="line.1979"></a>
<span class="sourceLineNo">1980</span>                public static String newStringUtf16Le(byte[] bytes) {<a name="line.1980"></a>
<span class="sourceLineNo">1981</span>                        return new String(bytes, Charsets.UTF_16LE);<a name="line.1981"></a>
<span class="sourceLineNo">1982</span>                }<a name="line.1982"></a>
<span class="sourceLineNo">1983</span><a name="line.1983"></a>
<span class="sourceLineNo">1984</span>                /**<a name="line.1984"></a>
<span class="sourceLineNo">1985</span>                 * Constructs a new &lt;code&gt;String&lt;/code&gt; by decoding the specified array<a name="line.1985"></a>
<span class="sourceLineNo">1986</span>                 * of bytes using the UTF-8 charset.<a name="line.1986"></a>
<span class="sourceLineNo">1987</span>                 * <a name="line.1987"></a>
<span class="sourceLineNo">1988</span>                 * @param bytes<a name="line.1988"></a>
<span class="sourceLineNo">1989</span>                 *            The bytes to be decoded into characters<a name="line.1989"></a>
<span class="sourceLineNo">1990</span>                 * @return A new &lt;code&gt;String&lt;/code&gt; decoded from the specified array of<a name="line.1990"></a>
<span class="sourceLineNo">1991</span>                 *         bytes using the UTF-8 charset, or {@code null} if the input<a name="line.1991"></a>
<span class="sourceLineNo">1992</span>                 *         byte array was {@code null}.<a name="line.1992"></a>
<span class="sourceLineNo">1993</span>                 * @throws NullPointerException<a name="line.1993"></a>
<span class="sourceLineNo">1994</span>                 *             Thrown if {@link Charsets#UTF_8} is not initialized,<a name="line.1994"></a>
<span class="sourceLineNo">1995</span>                 *             which should never happen since it is required by the<a name="line.1995"></a>
<span class="sourceLineNo">1996</span>                 *             Java platform specification.<a name="line.1996"></a>
<span class="sourceLineNo">1997</span>                 * @since As of 1.7, throws {@link NullPointerException} instead of<a name="line.1997"></a>
<span class="sourceLineNo">1998</span>                 *        UnsupportedEncodingException<a name="line.1998"></a>
<span class="sourceLineNo">1999</span>                 */<a name="line.1999"></a>
<span class="sourceLineNo">2000</span>                public static String newStringUtf8(byte[] bytes) {<a name="line.2000"></a>
<span class="sourceLineNo">2001</span>                        return newString(bytes, Charsets.UTF_8);<a name="line.2001"></a>
<span class="sourceLineNo">2002</span>                }<a name="line.2002"></a>
<span class="sourceLineNo">2003</span><a name="line.2003"></a>
<span class="sourceLineNo">2004</span>        }<a name="line.2004"></a>
<span class="sourceLineNo">2005</span><a name="line.2005"></a>
<span class="sourceLineNo">2006</span>}<a name="line.2006"></a>




























































</pre>
</div>
<script type="text/javascript">
                var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
                document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
                </script>
                <script type="text/javascript">
                try {
                var pageTracker = _gat._getTracker("UA-1395874-4");
                pageTracker._trackPageview();
                } catch(err) {}</script>
                </body >
</html>
